Skip to content

Conversation

@Mignonne-Patterson
Copy link

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

  • Added comprehensive MCP Server explanation: Clarified what the MCP Server is and why it's essential for awesome-copilot
  • Included setup instructions: Provided both quick-start and manual setup steps for users
  • Added Kubernetes as a requirement: Documented necessary dependencies and system requirements
  • Reorganized "How to Use" section: Restructured with detailed, step-by-step examples for each artifact type
  • Improved artifact type guidance: Enhanced documentation for Prompts, Instructions, Agents, and Collections with practical examples

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

  • I have read and followed the CONTRIBUTING.md guidelines
  • This is a documentation update to the README
  • The content is clearly structured and follows markdown best practices
  • I have tested the instructions for accuracy
  • I have run npm start and verified that all references are correct

Additional 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.

- 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
Copy link
Contributor

@aaronpowell aaronpowell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to disagree with this PR providing value and argue that it decreases the effectiveness of the README by making it excessively verbose and introduces inaccuracies (such as anthropic.config.json which is not where mcp servers are stored).

Including information such as "what is MCP" means that the README needs to be continually updated as MCP changes/evolves its documentation, which is beyond the responsibility of this repo, furthermore since the MCP server isn't actually part of the repo, stuff like troubleshooting should really be directed to the MCP server repo so the maintainers are aware and can action it.

This change added ~300 new lines to the file, which really makes it hard to get a glance at when the repo is about.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Enhance README

2 participants