Skip to content

Commit 32db557

Browse files
committed
Add contributing guidelines to prevent seed.json PRs
Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
1 parent 9c180f4 commit 32db557

3 files changed

Lines changed: 58 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Copilot Instructions for MCP Registry
2+
3+
## Important: Publishing MCP servers
4+
5+
The `data/seed.json` file is seed data for local development only. Do NOT create pull requests that add or modify server entries in `data/seed.json` to publish a server.
6+
7+
To publish an MCP server to the registry, use the `mcp-publisher` CLI tool. See `docs/modelcontextprotocol-io/quickstart.mdx` for instructions.
8+
9+
## Development
10+
11+
- Use `make` targets where possible (run `make help` to see available targets)
12+
- Run `make check` to run lint, unit tests, and integration tests
13+
- Run `make dev-compose` to start the local development environment

CLAUDE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22
_Guidance for Claude Code (claude.ai/code) when working in this repository. If it's also useful to humans (probably most things!), put the instructions in README.md instead._
33

44
Import @README.md
5+
6+
## Important: Publishing MCP servers
7+
8+
The `data/seed.json` file is seed data for local development only. Do NOT create pull requests or commits that add server entries to `data/seed.json` as a way to publish a server to the registry.
9+
10+
To publish an MCP server, use the `mcp-publisher` CLI tool. See `docs/modelcontextprotocol-io/quickstart.mdx` for instructions.

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing to the MCP Registry
2+
3+
Thank you for your interest in contributing!
4+
5+
## Want to publish an MCP server?
6+
7+
**Do NOT open a pull request to add your server to `data/seed.json`.**
8+
9+
The `data/seed.json` file is seed data used only for local development. Modifying it will not publish your server to the registry.
10+
11+
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.
12+
13+
## Contributing to the registry codebase
14+
15+
We welcome contributions to the registry itself! Here's how to get started:
16+
17+
### Communication channels
18+
19+
We use multiple channels for collaboration - see [modelcontextprotocol.io/community/communication](https://modelcontextprotocol.io/community/communication).
20+
21+
Often (but not always) ideas flow through this pipeline:
22+
23+
- **[Discord](https://modelcontextprotocol.io/community/communication)** - Real-time community discussions
24+
- **[Discussions](https://github.com/modelcontextprotocol/registry/discussions)** - Propose and discuss product/technical requirements
25+
- **[Issues](https://github.com/modelcontextprotocol/registry/issues)** - Track well-scoped technical work
26+
- **[Pull Requests](https://github.com/modelcontextprotocol/registry/pulls)** - Contribute work towards issues
27+
28+
### Development setup
29+
30+
See the [README](README.md#quick-start) for prerequisites and instructions on running the server locally.
31+
32+
### Running checks
33+
34+
```bash
35+
# Run lint, unit tests and integration tests
36+
make check
37+
```
38+
39+
Run `make help` for more available commands.

0 commit comments

Comments
 (0)