servers-modelcontextprotocol/CONTRIBUTING.md

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

Adding new servers is one of the most valuable ways to contribute. Before creating a new server:

• 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

2. Improvements to Existing Servers

Enhancements to existing servers are welcome! This includes:

• Bug fixes
• Performance improvements
• New features
• Documentation improvements
• Security enhancements

3. Documentation

Documentation improvements are always welcome:

• Fixing typos or unclear instructions
• Adding examples
• Improving setup instructions
• Adding troubleshooting guides

Getting Started

1. Fork the repository
2. Clone your fork:

   git clone https://github.com/your-username/mcp-servers.git
   

3. Add the upstream remote:

   git remote add upstream https://github.com/modelcontextprotocol/servers.git
   

4. Create a branch:

   git checkout -b my-feature
   

Development Guidelines

Code Style

• Follow the existing code style in the repository
• Use TypeScript for JavaScript/Node.js servers
• 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

Testing

• Add appropriate tests for new functionality
• Ensure existing tests pass
• Test your changes thoroughly

Security

• Follow security best practices
• Implement proper input validation
• Handle errors appropriately
• Document security considerations

Submitting Changes

1. Commit your changes:

   git add .
   git commit -m "Description of changes"
   

2. Push to your fork:

   git push origin my-feature
   

3. Create a Pull Request through GitHub

Pull Request Guidelines

• 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

Review Process

1. Maintainers will review your PR
2. Address any requested changes
3. Once approved, your PR will be merged

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!