Contributing to MCP TypeScript SDK
We welcome contributions to the Model Context Protocol TypeScript SDK! This document outlines the process for contributing to the project.
Getting Started
- Fork the repository
- Clone your fork:
git clone https://github.com/YOUR-USERNAME/typescript-sdk.git - Install dependencies:
npm install - Build the project:
npm run build - Run tests:
npm test
Development Process
- Create a new branch for your changes
- Make your changes
- Run
npm run lintto ensure code style compliance - Run
npm testto verify all tests pass - Submit a pull request
Pull Request Guidelines
- Follow the existing code style
- Include tests for new functionality
- Update documentation as needed
- Keep changes focused and atomic
- Provide a clear description of changes
Running Examples
- Start the server:
npm run server - Run the client:
npm run client
Code of Conduct
This project follows our Code of Conduct. Please review it before contributing.
Reporting Issues
- Use the GitHub issue tracker
- Search existing issues before creating a new one
- Provide clear reproduction steps
Security Issues
Please review our Security Policy for reporting security vulnerabilities.
License
By contributing, you agree that your contributions will be licensed under the MIT License.