Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update documentation on mcp-servers configuration.
- review outdated documention that still uses "tools:" and nested "mcp:" fields
- differentiate "tools" vs "mcp-servers"
- discuss adding from the MCP registry
Update MCP server documentation to clarify tools vs mcp-servers configuration formats
Sep 25, 2025
Collaborator
|
@copilot ignore legacy or migration issues |
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Contributor
Author
Done. I've removed all legacy format documentation and migration guidance from the MCP documentation. The docs now focus exclusively on the |
Copilot
AI
changed the title
Update MCP server documentation to clarify tools vs mcp-servers configuration formats
Update MCP server documentation to focus on mcp-servers configuration format
Sep 25, 2025
pelikhan
approved these changes
Sep 25, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the MCP (Model Context Protocol) server documentation to provide clear, streamlined guidance on MCP server configuration using the
mcp-servers:format and comprehensive documentation on GitHub MCP registry integration.Problem
The existing documentation had several issues:
gh aw mcp addSolution
Updated four key documentation files to provide clear, focused guidance on the
mcp-servers:configuration format:1. MCP Integration Guide (
docs/src/content/docs/guides/mcps.md)Streamlined to show only the
mcp-servers:format throughout:Added comprehensive MCP registry integration section with
gh aw mcp addcommand examples:2. Tools Reference (
docs/src/content/docs/reference/tools.md)Restructured to clearly separate MCP server configuration from built-in tools using the
mcp-servers:format:3. CLI Documentation (
docs/src/content/docs/tools/cli.md)Enhanced the MCP server management section with detailed registry features:
mcp-servers:formathttps://api.mcp.github.com/v04. Agent Instructions (
.github/instructions/github-agentic-workflows.instructions.md)Updated to show the
mcp-servers:format for AI agents to understand the recommended configuration approach.Key Benefits
Simplified Configuration: Users now have a single, clear format to learn:
mcp-servers:- Clean top-level configuration for MCP serverstools:configurationMCP Registry Integration: Comprehensive documentation on using
gh aw mcp addfor easy server discovery and automatic configuration from GitHub's registry.Streamlined User Experience: Eliminates decision fatigue and configuration confusion by focusing on a single recommended approach.
Validation: All examples compile correctly, and the
mcp-servers:format generates proper lock files with registry information preserved.This update provides a focused, streamlined approach to MCP server configuration in GitHub Agentic Workflows while maintaining all powerful features like registry integration and automatic server discovery.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.