47 lines
2.2 KiB
Markdown
47 lines
2.2 KiB
Markdown
# Contributing to Model Context Protocol Inspector
|
|
|
|
Thanks for your interest in contributing! This guide explains how to get involved.
|
|
|
|
## Getting Started
|
|
|
|
1. Fork the repository and clone it locally
|
|
2. Install dependencies with `npm install`
|
|
3. Run `npm run dev` to start both client and server in development mode
|
|
4. Use the web UI at http://localhost:6274 to interact with the inspector
|
|
|
|
## Inspector V2 Development
|
|
|
|
We're actively developing **Inspector V2** to address architectural and UX improvements. We invite you to follow progress and participate in the Inspector V2 Working Group in [Discord](https://modelcontextprotocol.io/community/communication), [weekly meetings](https://meet.modelcontextprotocol.io/tag/inspector-v2-wg), and [GitHub Discussions](https://github.com/modelcontextprotocol/modelcontextprotocol/discussions/categories/meeting-notes-other) (where notes are posted after meetings).
|
|
|
|
**Current version (V1) contribution scope:**
|
|
|
|
- Bug fixes and MCP spec compliance are actively maintained
|
|
- Documentation updates are always appreciated
|
|
- Major changes will be directed to V2 development
|
|
|
|
## Development Process & Pull Requests
|
|
|
|
1. Create a new branch for your changes
|
|
2. Make your changes following existing code style and conventions. You can run `npm run prettier-check` and `npm run prettier-fix` as applicable.
|
|
3. Test changes locally by running `npm test` and `npm run test:e2e`
|
|
4. Update documentation as needed
|
|
5. Use clear commit messages explaining your changes
|
|
6. Verify all changes work as expected
|
|
7. Submit a pull request
|
|
8. PRs will be reviewed by maintainers
|
|
|
|
## Code of Conduct
|
|
|
|
This project follows our [Code of Conduct](CODE_OF_CONDUCT.md). Please read it before contributing.
|
|
|
|
## Security
|
|
|
|
If you find a security vulnerability, please refer to our [Security Policy](SECURITY.md) for reporting instructions.
|
|
|
|
## Questions?
|
|
|
|
Feel free to [open an issue](https://github.com/modelcontextprotocol/inspector/issues) for questions or join the MCP Contributor [Discord server](https://modelcontextprotocol.io/community/communication). Also, please see notes above on Inspector V2 Development.
|
|
|
|
## License
|
|
|
|
By contributing, you agree that your contributions will be licensed under the MIT license.
|