-
Notifications
You must be signed in to change notification settings - Fork 0
Add enhanced best practices to MCP documentation #18
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
base: main
Are you sure you want to change the base?
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.
Copilot wasn't able to review any files in this pull request.
…nagement Co-authored-by: chikamsoachumsft <224665915+chikamsoachumsft@users.noreply.github.com>
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
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
docs/2-mcp.md:1
- The model comparison information may become outdated quickly. Consider adding a note that these are general characteristics at the time of writing and that users should refer to current model documentation for up-to-date capabilities and availability.
# Exercise 2 - Setting up the backlog with Copilot agent mode and GitHub's MCP Server
| > **MCP Configuration Best Practices**: | ||
| > - **Remote vs Local**: Use remote MCP servers when available for easier maintenance and OAuth authentication | ||
| > - **Version Control**: Include `mcp.json` in version control, but never commit sensitive credentials | ||
| > - **Documentation**: Comment your MCP configurations to explain which servers are used and why |
Copilot
AI
Oct 29, 2025
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.
The guidance to 'comment your MCP configurations' may be misleading since JSON format doesn't support comments natively. Consider clarifying this to suggest using adjacent documentation (like a README) or referring to JSON5/JSONC if supported by VS Code's mcp.json parser.
| > - **Documentation**: Comment your MCP configurations to explain which servers are used and why | |
| > - **Documentation**: Standard JSON does not support comments. Document your MCP configurations in an adjacent README file, or use JSONC/JSON5 syntax if your environment (such as VS Code's parser) supports it. |
Enhances
docs/2-mcp.mdwith actionable security, workflow, and review guidance for MCP setup, Copilot agent mode usage, and backlog management.Security Best Practices
Copilot Agent Mode Guidance
Backlog Management
MCP Configuration
Example enhancement - before:
After:
~80 lines of enhanced guidance added across 7 sections. All cross-references and document structure preserved.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
https://api.github.com/repos/chikamsoachumsft/agents_tutorial1/pullscurl -X POST -H Accept: application/vnd.github+json -H Authorization: Bearer REDACTED -d { "title": "Enhanced MCP Documentation Best Practices", "body": "This PR updates docs/2-mcp.md with enhanced best practices for MCP setup, Copilot agent mode, and backlog management.", "head": "copilot/update-docs-mcp-best-practices", "base": "improve-doc-best-practices" }(http block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
This pull request was created as a result of the following prompt from Copilot chat.
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.