-
Notifications
You must be signed in to change notification settings - Fork 3.5k
docs: add Copilot CLI installation guide #1913
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add Copilot CLI installation guide #1913
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds comprehensive installation documentation for configuring the GitHub MCP Server with Copilot CLI, filling a documentation gap alongside existing guides for other MCP hosts.
Changes:
- Added complete installation guide for Copilot CLI with prerequisites, configuration methods, and troubleshooting
- Updated main README.md to include Copilot CLI in two installation guide reference lists
- Updated docs/installation-guides/README.md to add Copilot CLI to both the guides list and support comparison table
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/installation-guides/install-copilot-cli.md | New 136-line installation guide covering prerequisites, remote/local/binary setup methods, verification steps, and troubleshooting |
| docs/installation-guides/README.md | Added Copilot CLI entry to guides list and support table with configuration details |
| README.md | Added Copilot CLI links to two installation guide reference sections |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
SamMorrowDrums
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this.
| <summary><b>Storing Your PAT Securely</b></summary> | ||
| <br> | ||
|
|
||
| For security, avoid hardcoding your token. Set your PAT as an environment variable: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks so much for this, one question. Surely it's not secure to export the secret so it's available in the shell env for all applications? It might be best option, I'm just not sure we should call it out as secure.
I'm not sure there is an excellent solution that isn't complex to document, like using a credential manager and passing in the env each time at startup.
We also should presumably be able to make oauth work, will open a ticket to look at that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, the use of the word secure there is spurious at best. I'll remove that.
|
Merged although I hope we can add 1p oauth for user-configured GH MCP as we do in VS Code |
Summary
Adds installation instructions for the GitHub MCP Server in Copilot CLI.
Why
Users need documentation on how to configure the GitHub MCP Server with Copilot CLI, similar to existing guides for other MCP hosts like Gemini CLI, Claude, and Cursor.
What changed
docs/installation-guides/install-copilot-cli.mdwith complete setup instructionsREADME.mdto include Copilot CLI in both installation guide listsdocs/installation-guides/README.mdto include Copilot CLI in guides list and support tableMCP impact
Prompts tested (tool changes only)
N/A - documentation only
Security / limits
Tool renaming
Lint & tests
./script/lint- N/A for docs-only changes./script/test- N/A for docs-only changesDocs