docs: enhance README with MCP Server setup and usage guidance#682
Open
Mignonne-Patterson wants to merge 1 commit intogithub:mainfrom
Open
docs: enhance README with MCP Server setup and usage guidance#682Mignonne-Patterson wants to merge 1 commit intogithub:mainfrom
Mignonne-Patterson wants to merge 1 commit intogithub:mainfrom
Conversation
- Add comprehensive MCP explanation - Include setup instructions (quick + manual) - Add Kubernetes as a requirement - Reorganize "How to Use" section with detailed examples - Improve artifact type guidance (Prompts, Instructions, Agents, Collections) Fixes github#641
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
1 participant
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.
Description
This PR addresses issue #641 by significantly improving the README documentation, particularly the "How to Use" section. The current documentation lacks clarity on how users can leverage the MCP Server to install and utilize awesome-copilot artifacts (prompts, instructions, agents, collections, etc).
Changes Made
Motivation and Context
The existing README assumes users understand how to work with MCP Servers and use awesome-copilot artifacts. This PR makes the documentation more accessible to new users while providing sufficient detail for advanced users.
Fixes #641
Pull Request Checklist
npm startand verified that all references are correctAdditional Notes
This PR prioritizes clarity and accessibility while maintaining the awesome-copilot project's standards. All changes focus on improving user onboarding and understanding of the MCP Server integration.
By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.