refactor(CONTRIBUTING.md): streamline contribution guidelines and improve clarity

This commit is contained in:
Adam Jones
2025-08-23 07:04:42 +00:00
parent fd886fac9c
commit c6cccec4e9

View File

@@ -1,105 +1,33 @@
# Contributing to MCP Servers # Contributing to MCP Servers
Thank you for your interest in contributing to the Model Context Protocol (MCP) servers! This document provides guidelines and instructions for contributing. Thanks for your interest in contributing! Here's how you can help make this repo better.
## Types of Contributions We accept changes through [the standard GitHub flow model](https://docs.github.com/en/get-started/using-github/github-flow).
### 1. New Servers ## Server Listings
The repository contains reference implementations, as well as a list of community servers. We welcome PRs that add links to your servers in the [README.md](./README.md)!
We generally don't accept new servers into the repository. We do accept pull requests to the [README.md](./README.md)
adding a reference to your servers.
Please keep lists in alphabetical order to minimize merge conflicts when adding new items. ## Server Implementations
- Check the [modelcontextprotocol.io](https://modelcontextprotocol.io) documentation We welcome:
- Ensure your server doesn't duplicate existing functionality - **Bug fixes** — Help us squash those pesky bugs.
- Consider whether your server would be generally useful to others - **Ergonomic improvements** — Making servers easier to use for humans and agents.
- Follow [security best practices](https://modelcontextprotocol.io/docs/concepts/transports#security-considerations) from the MCP documentation
- Create a PR adding a link to your server to the [README.md](./README.md).
### 2. Improvements to Existing Servers We're more selective about:
Enhancements to existing servers are welcome! This includes: - **New features** — Especially if they're not crucial to the server's core purpose or are highly opinionated. The existing servers are reference servers meant to inspire the community. If you need specific features, we encourage you to build enhanced versions! We think a diverse ecosystem of servers is beneficial for everyone, and would love to link to your improved server in our README.
- Bug fixes We don't accept:
- Performance improvements - **New server implementations** — We encourage you to publish them yourself, and link to them from the README.
- New features
- Security enhancements
### 3. Documentation ## Documentation
Documentation improvements are always welcome:
- Fixing typos or unclear instructions Improvements to existing documentation is welcome - although generally we'd prefer ergonomic improvements than documenting pain points if possible!
- Adding examples
- Improving setup instructions
- Adding troubleshooting guides
## Getting Started We're more selective about adding wholly new documentation, especially in ways that aren't vendor neutral (e.g. how to run a particular server with a particular client).
1. Fork the repository
2. Clone your fork:
```bash
git clone https://github.com/your-username/servers.git
```
3. Add the upstream remote:
```bash
git remote add upstream https://github.com/modelcontextprotocol/servers.git
```
4. Create a branch:
```bash
git checkout -b my-feature
```
## Development Guidelines
### Code Style
- Follow the existing code style in the repository
- Include appropriate type definitions
- Add comments for complex logic
### Documentation
- Include a detailed README.md in your server directory
- Document all configuration options
- Provide setup instructions
- Include usage examples
### Security
- Follow security best practices
- Implement proper input validation
- Handle errors appropriately
- Document security considerations
## Submitting Changes
1. Commit your changes:
```bash
git add .
git commit -m "Description of changes"
```
2. Push to your fork:
```bash
git push origin my-feature
```
3. Create a Pull Request through GitHub
### Pull Request Guidelines
- Thoroughly test your changes
- Fill out the pull request template completely
- Link any related issues
- Provide clear description of changes
- Include any necessary documentation updates
- Add screenshots for UI changes
- List any breaking changes
## Community ## Community
- Participate in [GitHub Discussions](https://github.com/orgs/modelcontextprotocol/discussions) [Learn how the MCP community communicates](https://modelcontextprotocol.io/community/communication).
- Follow the [Code of Conduct](CODE_OF_CONDUCT.md)
## Questions? Thank you for helping make MCP servers better for everyone!
- Check the [documentation](https://modelcontextprotocol.io)
- Ask in GitHub Discussions
Thank you for contributing to MCP Servers!