docs: enhance README with MCP Server setup and usage guidance

[Mignonne-Patterson]

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.

[aaronpowell]

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.

[Mignonne-Patterson]

I understand your perspective, but I believe the PR adds significant value by making the README more comprehensive and self-contained for users who may not be familiar with all the ecosystem components. The additional context around MCP is helpful because it clarifies dependencies and expectations without assuming prior knowledge, which aligns with the goal of making this repo as accessible as possible.

Regarding the concern about "anthropic.config.json," I agree that this example may be misleading. However, the PR's intention was to provide an illustrative example rather than a definitive guide—this is something that could be clarified or replaced with more accurate information in a follow-up.

As for the length of the README, while it's true that adding ~300 lines increases the file size, this is a trade-off for improved usability. The information included helps users understand how to set up and use the repo without needing to navigate external documentation or rely on external repos for troubleshooting. It’s also worth noting that a well-structured README can be more readable than a minimalist one, especially when providing clear sections and headings.

Ultimately, the goal of this PR was to reduce friction for new contributors and users. I believe this is a worthwhile trade-off, even if the README becomes slightly longer.