38 lines
1.3 KiB
Markdown
38 lines
1.3 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://127.0.0.1:5173 to interact with the inspector
|
|
|
|
## 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`
|
|
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/mcp-inspector/issues) for questions or create a discussion for general topics.
|
|
|
|
## License
|
|
|
|
By contributing, you agree that your contributions will be licensed under the MIT license.
|