ddb93bd3a8<!-- Provide a brief summary of your changes --> ## Motivation and Context <!-- Why is this change needed? What problem does it solve? --> We've been receiving numerous PRs from authors attempting to publish their MCP server by adding entries to `data/seed.json`. This is not the correct approach as servers should be published using the `mcp-publisher` CLI tool. Many of these PRs appear to be AI-generated so the existing docs aren't being surfaced effectively. This PR adds explicit guidance in the files that AI coding assistants actually read: - `CONTRIBUTING.md` - shown by GitHub when opening new PRs; widely ingested by AI tools - `.github/copilot-instructions.md` - read by GitHub Copilot - `CLAUDE.md` - read by Claude Code and Claude on github.com ## How Has This Been Tested? <!-- Have you tested this in a real application? Which scenarios were tested? --> ## Breaking Changes <!-- Will users need to update their code or configurations? --> ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [ ] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [ ] My code follows the repository's style guidelines - [ ] New and existing tests pass locally - [ ] I have added appropriate error handling - [ ] I have added or updated documentation as needed ## Additional context <!-- Add any other context, implementation notes, or design decisions --> Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
39 lines
No EOL
1.6 KiB
Markdown
39 lines
No EOL
1.6 KiB
Markdown
# Contributing to the MCP Registry
|
|
|
|
Thank you for your interest in contributing!
|
|
|
|
## Want to publish an MCP server?
|
|
|
|
**Do NOT open a pull request to add your server to `data/seed.json`.**
|
|
|
|
The `data/seed.json` file is seed data used only for local development. Modifying it will not publish your server to the registry.
|
|
|
|
To publish an MCP server, use the official `mcp-publisher` CLI tool. See the [publishing quickstart guide](docs/modelcontextprotocol-io/quickstart.mdx) for step-by-step instructions.
|
|
|
|
## Contributing to the registry codebase
|
|
|
|
We welcome contributions to the registry itself! Here's how to get started:
|
|
|
|
### Communication channels
|
|
|
|
We use multiple channels for collaboration - see [modelcontextprotocol.io/community/communication](https://modelcontextprotocol.io/community/communication).
|
|
|
|
Often (but not always) ideas flow through this pipeline:
|
|
|
|
- **[Discord](https://modelcontextprotocol.io/community/communication)** - Real-time community discussions
|
|
- **[Discussions](https://github.com/modelcontextprotocol/registry/discussions)** - Propose and discuss product/technical requirements
|
|
- **[Issues](https://github.com/modelcontextprotocol/registry/issues)** - Track well-scoped technical work
|
|
- **[Pull Requests](https://github.com/modelcontextprotocol/registry/pulls)** - Contribute work towards issues
|
|
|
|
### Development setup
|
|
|
|
See the [README](README.md#quick-start) for prerequisites and instructions on running the server locally.
|
|
|
|
### Running checks
|
|
|
|
```bash
|
|
# Run lint, unit tests and integration tests
|
|
make check
|
|
```
|
|
|
|
Run `make help` for more available commands. |