|
| 1 | +# Contributing to getmcp.io |
| 2 | + |
| 3 | +Thank you for considering contributing to getmcp.io! This document outlines the process for adding or updating MCP servers in the registry. |
| 4 | + |
| 5 | +## Adding a New Server |
| 6 | + |
| 7 | +1. Fork this repository |
| 8 | +2. Create a new JSON file named after your server under `mcp-registry/servers/` (use kebab-case, e.g., `github.json` or `time-converter.json`) |
| 9 | +3. Ensure your server JSON file adheres to the [server schema](/mcp-registry/schema/server-schema.json) |
| 10 | + |
| 11 | +### Server JSON Requirements |
| 12 | + |
| 13 | +Your server JSON file must include the following required fields: |
| 14 | + |
| 15 | +```json |
| 16 | +{ |
| 17 | + "name": "your-server-name", |
| 18 | + "display_name": "Your Server Display Name", |
| 19 | + "description": "Brief description of the server's functionality", |
| 20 | + "repository": { |
| 21 | + "type": "git", |
| 22 | + "url": "https://github.com/your-username/your-repo" |
| 23 | + }, |
| 24 | + "author": { |
| 25 | + "name": "Your Name" |
| 26 | + }, |
| 27 | + "license": "MIT", |
| 28 | + "categories": ["category1", "category2"], |
| 29 | + "tags": ["tag1", "tag2"], |
| 30 | + "arguments": { |
| 31 | + "EXAMPLE_ARG": { |
| 32 | + "description": "Description of this argument", |
| 33 | + "required": false |
| 34 | + } |
| 35 | + }, |
| 36 | + "commands": { |
| 37 | + "npm": { |
| 38 | + "type": "npm", |
| 39 | + "command": "npx", |
| 40 | + "args": ["your-server-package"], |
| 41 | + "env": { |
| 42 | + "EXAMPLE_ARG": "${EXAMPLE_ARG}" |
| 43 | + } |
| 44 | + } |
| 45 | + }, |
| 46 | + "examples": [ |
| 47 | + { |
| 48 | + "title": "Example usage", |
| 49 | + "description": "Brief description of example", |
| 50 | + "prompt": "Example prompt to demonstrate server functionality" |
| 51 | + } |
| 52 | + ] |
| 53 | +} |
| 54 | +``` |
| 55 | + |
| 56 | +For a complete reference of all available fields, see the [server schema](/mcp-registry/schema/server-schema.json). |
| 57 | + |
| 58 | +## Schema Validation |
| 59 | + |
| 60 | +All server JSON files are automatically validated against the schema during the CI process. You can also validate your server JSON locally using the prepare.py script: |
| 61 | + |
| 62 | +```bash |
| 63 | +# From the repository root |
| 64 | +python scripts/prepare.py mcp-registry pages --validate-only |
| 65 | +``` |
| 66 | + |
| 67 | +## Updating an Existing Server |
| 68 | + |
| 69 | +1. Fork this repository |
| 70 | +2. Update the relevant server JSON file in the `mcp-registry/servers/` directory |
| 71 | +3. Submit a pull request with a clear description of your changes |
| 72 | + |
| 73 | +## Website Development |
| 74 | + |
| 75 | +If you want to contribute to the getmcp.io website itself: |
| 76 | + |
| 77 | +1. Fork and clone the repository |
| 78 | +2. Run the development server: |
| 79 | + |
| 80 | +```bash |
| 81 | +./dev.sh |
| 82 | +``` |
| 83 | + |
| 84 | +3. Access the site at http://localhost:4000 |
| 85 | +4. Make your changes to the files in the `pages/` directory |
| 86 | +5. Submit a pull request with a clear description of your changes |
| 87 | + |
| 88 | +## Design Guidelines |
| 89 | + |
| 90 | +getmcp.io follows a minimal, clean design philosophy: |
| 91 | + |
| 92 | +- Stick to a minimal black and white color scheme |
| 93 | +- Focus on functionality and readability |
| 94 | +- Follow modern web design patterns |
| 95 | +- Keep UI elements simple and focused on content |
| 96 | + |
| 97 | +## Code of Conduct |
| 98 | + |
| 99 | +Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms. |
| 100 | + |
| 101 | +## License |
| 102 | + |
| 103 | +By contributing to this repository, you agree to license your contributions under the same license as this repository. |
0 commit comments