mirror of
https://github.com/modelcontextprotocol/servers.git
synced 2025-04-13 23:15:37 +03:00
2.9 KiB
2.9 KiB
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.
Types of Contributions
1. New Servers
The repository contains reference implementations, as well as a list of community servers. We generally don't accept new servers into the repository. We do accept pull requests to the README.md adding a reference to your servers.
Please keep lists in alphabetical order to minimize merge conflicts when adding new items.
- Check the modelcontextprotocol.io documentation
- Ensure your server doesn't duplicate existing functionality
- Consider whether your server would be generally useful to others
- Follow security best practices from the MCP documentation
- Create a PR adding a link to your server to the README.md.
2. Improvements to Existing Servers
Enhancements to existing servers are welcome! This includes:
- Bug fixes
- Performance improvements
- New features
- Security enhancements
3. Documentation
Documentation improvements are always welcome:
- Fixing typos or unclear instructions
- Adding examples
- Improving setup instructions
- Adding troubleshooting guides
Getting Started
- Fork the repository
- Clone your fork:
git clone https://github.com/your-username/servers.git - Add the upstream remote:
git remote add upstream https://github.com/modelcontextprotocol/servers.git - Create a branch:
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
- Commit your changes:
git add . git commit -m "Description of changes" - Push to your fork:
git push origin my-feature - 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
- Participate in GitHub Discussions
- Follow the Code of Conduct
Questions?
- Check the documentation
- Ask in GitHub Discussions
Thank you for contributing to MCP Servers!