github-mcp-server icon indicating copy to clipboard operation
github-mcp-server copied to clipboard

Revise GitHub MCP configuration in README

Open jamesmontemagno opened this issue 1 month ago • 1 comments

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

jamesmontemagno avatar Nov 06 '25 22:11 jamesmontemagno

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" https://api.github.com/repos/github/github-mcp-server/pulls/1370/reviews -d '{"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.","event":"COMMENT"}'

aUsABuisnessman avatar Nov 24 '25 17:11 aUsABuisnessman