Reorganize README, add dedicated install guides, include policies and governance info for the github server #695
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR reorganizes and improves the documentation structure for the GitHub MCP Server by creating dedicated installation guides for different host applications and adding comprehensive policies and governance information. The restructuring makes it easier for users to find setup instructions specific to their development environment.
Key changes:
- Restructured README with clearer organization and focused installation sections
- Created dedicated installation guides for major host applications (Claude, Cursor, Windsurf, Copilot IDEs)
- Added comprehensive policies and governance documentation covering enterprise controls and security
- Updated contribution guidelines with clearer approval criteria
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/policies-and-governance.md | New comprehensive documentation covering enterprise control mechanisms, authentication methods, and governance policies |
| docs/installation-guides/ | New directory with dedicated installation guides for different host applications |
| README.md | Restructured for better clarity with streamlined installation sections and references to new guides |
| CONTRIBUTING.md | Added section clarifying approval criteria and what types of contributions are prioritized |
Comments suppressed due to low confidence (1)
docs/policies-and-governance.md:186
- The terminology is inconsistent and confusing. It should be 'Prefer fine-grained PATs to classic PATs' for clarity.
* Prefer fine-grained PATs to PATs (Classic)
|
|
||
| --- | ||
|
|
||
| ## JetBrains IDEs |
There was a problem hiding this comment.
@phanthaiduong22 Do you mind confirming all the installation steps for Copilot in JetBrains, Eclipse and Xcode?
There was a problem hiding this comment.
@jdneo @testforstephen for Eclipse/Xcode installation steps
|
Awesome!! I'd say rename |
- Reorganized README for clarity and navigation - Added dedicated installation guides for Claude, Cursor, Windsurf, JetBrains, and more - Clarified contribution guidelines and approval criteria - Added policies and governance documentation
Removing coding agent from the policy note, as the GitHub server is unaffected by this policy
...to reflect changes in accessing settings and configuring MCP.
...for GitHub Copilot plugin in installation guide.
| ```bash | ||
| claude mcp add-json github '{"command": "docker", "args": ["run", "-i", "--rm", "-e", "GITHUB_PERSONAL_ACCESS_TOKEN", "ghcr.io/github/github-mcp-server"], "env": {"GITHUB_PERSONAL_ACCESS_TOKEN": "your_github_pat"}}' |
There was a problem hiding this comment.
I tested the cli with remote mcp and it works well, but I am happy to add the remote configuration as a seperate pr
| ## Support by Host Application | ||
|
|
||
| | Host Application | Local GitHub MCP Support | Remote GitHub MCP Support | Prerequisites | Difficulty | | ||
| |-----------------|---------------|----------------|---------------|------------| |
This PR improves the docs structure and clarity for the GitHub MCP Server, and add a policies and governance doc for info on control mechanisms.
Changes
/docs/installation-guides/install-other-copilot-ides.md- JetBrains, Visual Studio, Eclipse, Xcode/docs/installation-guides/install-claude.md- Claude Web, Desktop, and Code CLI/docs/installation-guides/install-cursor.md- Cursor IDE/docs/installation-guides/install-windsurf.md- Windsurf IDE/docs/policies-and-governance.mdImpact
These changes make it easier for users to find installation instructions for their specific host application, understand how requests are prioritized, and governance policies.