Skip to content

Commit 17d9340

Browse files
authored
Merge pull request #911 from olaservo/add-v2-updates-and-pr-template
Add Inspector V2 development notices and PR template
2 parents c91960c + cbb6a0a commit 17d9340

File tree

4 files changed

+75
-1
lines changed

4 files changed

+75
-1
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,7 @@ If applicable, add screenshots to help explain your problem.
3434

3535
**Additional context**
3636
Add any other context about the problem here.
37+
38+
**Version Consideration**
39+
40+
Inspector V2 is under development to address architectural and UX improvements. See [CONTRIBUTING.md](CONTRIBUTING.md) for information about V2 development.

.github/pull_request_template.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
## Summary
2+
3+
<!-- Provide a brief description of what this PR does -->
4+
5+
> **Note:** Inspector V2 is under development to address architectural and UX improvements. See [CONTRIBUTING.md](CONTRIBUTING.md) for information about V2 development.
6+
7+
## Type of Change
8+
9+
<!-- Mark the relevant option with an "x" -->
10+
11+
- [ ] Bug fix (non-breaking change that fixes an issue)
12+
- [ ] New feature (non-breaking change that adds functionality)
13+
- [ ] Documentation update
14+
- [ ] Refactoring (no functional changes)
15+
- [ ] Test updates
16+
- [ ] Build/CI improvements
17+
18+
## Changes Made
19+
20+
<!-- Describe the changes in detail. Include screenshots/recordings if applicable -->
21+
22+
## Related Issues
23+
24+
<!-- Link to related issues using #issue_number or "Fixes #issue_number" -->
25+
26+
## Testing
27+
28+
<!-- Describe how you tested these changes, where applicable -->
29+
30+
- [ ] Tested in UI mode
31+
- [ ] Tested in CLI mode
32+
- [ ] Tested with STDIO transport
33+
- [ ] Tested with SSE transport
34+
- [ ] Tested with Streamable HTTP transport
35+
- [ ] Added/updated automated tests
36+
- [ ] Manual testing performed
37+
38+
### Test Results and/or Instructions
39+
40+
<!-- Provide steps for reviewers to test your changes -->
41+
42+
Screenshots are encouraged to share your testing results for this change.
43+
44+
## Checklist
45+
46+
- [ ] Code follows the style guidelines (ran `npm run prettier-fix`)
47+
- [ ] Self-review completed
48+
- [ ] Code is commented where necessary
49+
- [ ] Documentation updated (README, comments, etc.)
50+
51+
## Breaking Changes
52+
53+
<!-- If this is a breaking change, describe the impact and migration path -->
54+
55+
## Additional Context
56+
57+
<!-- Add any other context, screenshots, or information about the PR here -->

AGENTS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# MCP Inspector Development Guide
22

3+
> **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.
4+
35
## Build Commands
46

57
- Build all: `npm run build`

CONTRIBUTING.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,17 @@ Thanks for your interest in contributing! This guide explains how to get involve
99
3. Run `npm run dev` to start both client and server in development mode
1010
4. Use the web UI at http://localhost:6274 to interact with the inspector
1111

12+
## Inspector V2 Development
13+
14+
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).
15+
16+
**Current version (V1) contribution scope:**
17+
18+
- Critical issues are actively maintained
19+
- Small UX improvements are welcome
20+
- Documentation updates are always appreciated
21+
- Major changes will be directed to V2 development
22+
1223
## Development Process & Pull Requests
1324

1425
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
3041

3142
## Questions?
3243

33-
Feel free to [open an issue](https://github.com/modelcontextprotocol/mcp-inspector/issues) for questions or create a discussion for general topics.
44+
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.
3445

3546
## License
3647

0 commit comments

Comments
 (0)