diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 0db5467a5..31eb7a224 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -34,3 +34,7 @@ If applicable, add screenshots to help explain your problem. **Additional context** Add any other context about the problem here. + +**Version Consideration** + +Inspector V2 is under development to address architectural and UX improvements. See [CONTRIBUTING.md](CONTRIBUTING.md) for information about V2 development. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..50189d360 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,57 @@ +## Summary + + + +> **Note:** Inspector V2 is under development to address architectural and UX improvements. See [CONTRIBUTING.md](CONTRIBUTING.md) for information about V2 development. + +## Type of Change + + + +- [ ] Bug fix (non-breaking change that fixes an issue) +- [ ] New feature (non-breaking change that adds functionality) +- [ ] Documentation update +- [ ] Refactoring (no functional changes) +- [ ] Test updates +- [ ] Build/CI improvements + +## Changes Made + + + +## Related Issues + + + +## Testing + + + +- [ ] Tested in UI mode +- [ ] Tested in CLI mode +- [ ] Tested with STDIO transport +- [ ] Tested with SSE transport +- [ ] Tested with Streamable HTTP transport +- [ ] Added/updated automated tests +- [ ] Manual testing performed + +### Test Results and/or Instructions + + + +Screenshots are encouraged to share your testing results for this change. + +## Checklist + +- [ ] Code follows the style guidelines (ran `npm run prettier-fix`) +- [ ] Self-review completed +- [ ] Code is commented where necessary +- [ ] Documentation updated (README, comments, etc.) + +## Breaking Changes + + + +## Additional Context + + diff --git a/AGENTS.md b/AGENTS.md index ec826b1fd..b0e467129 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,5 +1,7 @@ # MCP Inspector Development Guide +> **Note:** Inspector V2 is under development to address architectural and UX improvements. These guidelines apply to the current version (V1). See [CONTRIBUTING.md](CONTRIBUTING.md) for information about V2 development. + ## Build Commands - Build all: `npm run build` diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0129a9e32..9f98adcfa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,6 +9,17 @@ Thanks for your interest in contributing! This guide explains how to get involve 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:** + +- Critical issues are actively maintained +- Small UX improvements are welcome +- 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 @@ -30,7 +41,7 @@ If you find a security vulnerability, please refer to our [Security Policy](SECU ## Questions? -Feel free to [open an issue](https://github.com/modelcontextprotocol/mcp-inspector/issues) for questions or create a discussion for general topics. +Feel free to [open an issue](https://github.com/modelcontextprotocol/mcp-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