Revise GitHub MCP configuration in README#1370
Conversation
Updated the JSON configuration for GitHub integration in the README. Removed the old MCP structure and replaced it with a new format that includes server and input specifications.
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the MCP server configuration documentation to eliminate redundancy and improve clarity. The main change consolidates duplicate JSON configuration examples into a single, reusable format.
Key Changes:
- Updated the GitHub Enterprise Server/Cloud configuration example to use the standardized format with
inputsandserverskeys - Removed duplicate JSON configuration block that was shown for "other IDEs"
- Removed the collapsible section showing the same example "without the MCP key"
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "args": [ | ||
| "run", | ||
| "-i", | ||
| "--rm", |
There was a problem hiding this comment.
The updated Docker command is missing the -e flags that were present in the original configuration. Without -e GITHUB_PERSONAL_ACCESS_TOKEN and -e GITHUB_HOST, the environment variables defined in the env block will not be passed to the Docker container.
| "--rm", | |
| "--rm", | |
| "-e", | |
| "GITHUB_PERSONAL_ACCESS_TOKEN", | |
| "-e", | |
| "GITHUB_HOST", |
|
gh pr review 1370 --comment --repo github/github-mcp-server --body "Thanks for the cleanup — this is a useful improvement. A few suggestions to make the docs even more helpful:\n\n1. Environment variable name: ensure the same name is used throughout (e.g., GITHUB_MCP_TOKEN) so examples are consistent.\n2. Token scopes: add a short note listing the minimum token scopes required (so integrators know what permissions to grant).\n3. Deployment examples: include one-liners or snippets for setting the env var in systemd and Docker/Docker Compose (copy-paste friendly).\n4. Troubleshooting: expand with common error messages and a short example of the logs users will see when auth or config is wrong.\n5. Links: add a link to the MCP configuration reference or a sample config file in the repo for users who want advanced options.\n6. Small nit: check formatting of the YAML block under “Example configuration” — a language marker (yaml) would help readability." REST API (curl): curl -X POST -H "Authorization: token $GITHUB_TOKEN" -H "Accept: application/vnd.github+json" |
Updated the JSON configuration for GitHub integration in the README. Removed the old MCP structure and replaced it with a new format that includes server and input specifications.
Simplifies the directions. the "mcp" node isn't used anymore