You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/bug_report.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,3 +34,7 @@ If applicable, add screenshots to help explain your problem.
34
34
35
35
**Additional context**
36
36
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. During this time, V1 contributions should focus on **bug fixes and MCP spec compliance**. See [CONTRIBUTING.md](../../CONTRIBUTING.md) for more details.
<!-- Provide a brief description of what this PR does -->
4
+
5
+
> **Note:** Inspector V2 is under development to address architectural and UX improvements. During this time, V1 contributions should focus on **bug fixes and MCP spec compliance**. See [CONTRIBUTING.md](../CONTRIBUTING.md) for more details.
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`)
Copy file name to clipboardExpand all lines: AGENTS.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
# MCP Inspector Development Guide
2
2
3
+
> **Note:** Inspector V2 is under development to address architectural and UX improvements. During this time, V1 contributions should focus on **bug fixes and MCP spec compliance**. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-1Lines changed: 11 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,16 @@ Thanks for your interest in contributing! This guide explains how to get involve
9
9
3. Run `npm run dev` to start both client and server in development mode
10
10
4. Use the web UI at http://localhost:6274 to interact with the inspector
11
11
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
+
- Bug fixes and MCP spec compliance are actively maintained
19
+
- Documentation updates are always appreciated
20
+
- Major changes will be directed to V2 development
21
+
12
22
## Development Process & Pull Requests
13
23
14
24
1. Create a new branch for your changes
@@ -30,7 +40,7 @@ If you find a security vulnerability, please refer to our [Security Policy](SECU
30
40
31
41
## Questions?
32
42
33
-
Feel free to [open an issue](https://github.com/modelcontextprotocol/mcp-inspector/issues) for questions or create a discussion for general topics.
43
+
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.
|`MCP_SERVER_REQUEST_TIMEOUT`| Timeout for requests to the MCP server (ms) | 10000 |
242
-
|`MCP_REQUEST_TIMEOUT_RESET_ON_PROGRESS`| Reset timeout on progress notifications | true |
243
-
|`MCP_REQUEST_MAX_TOTAL_TIMEOUT`| Maximum total timeout for requests sent to the MCP server (ms) (Use with progress notifications) | 60000 |
244
-
|`MCP_PROXY_FULL_ADDRESS`| Set this if you are running the MCP Inspector Proxy on a non-default address. Example: http://10.1.1.22:5577| "" |
245
-
|`MCP_AUTO_OPEN_ENABLED`| Enable automatic browser opening when inspector starts (works with authentication enabled). Only as environment var, not configurable in browser. | true |
|`MCP_SERVER_REQUEST_TIMEOUT`| Client-side timeout (ms) - Inspector will cancel the request if no response is received within this time. Note: servers may have their own timeouts | 300000 |
247
+
|`MCP_REQUEST_TIMEOUT_RESET_ON_PROGRESS`| Reset timeout on progress notifications | true |
248
+
|`MCP_REQUEST_MAX_TOTAL_TIMEOUT`| Maximum total timeout for requests sent to the MCP server (ms) (Use with progress notifications) | 60000 |
249
+
|`MCP_PROXY_FULL_ADDRESS`| Set this if you are running the MCP Inspector Proxy on a non-default address. Example: http://10.1.1.22:5577| "" |
250
+
|`MCP_AUTO_OPEN_ENABLED`| Enable automatic browser opening when inspector starts (works with authentication enabled). Only as environment var, not configurable in browser. | true |
251
+
252
+
**Note on Timeouts:** The timeout settings above control when the Inspector (as an MCP client) will cancel requests. These are independent of any server-side timeouts. For example, if a server tool has a 10-minute timeout but the Inspector's timeout is set to 30 seconds, the Inspector will cancel the request after 30 seconds. Conversely, if the Inspector's timeout is 10 minutes but the server times out after 30 seconds, you'll receive the server's timeout error. For tools that require user interaction (like elicitation) or long-running operations, ensure the Inspector's timeout is set appropriately.
246
253
247
254
These settings can be adjusted in real-time through the UI and will persist across sessions.
|**Automation**| N/A | Ideal for CI/CD pipelines, batch processing, and integration with coding assistants |
457
464
|**Learning MCP**| Rich visual interface helps new users understand server capabilities | Simplified commands for focused learning of specific endpoints |
458
465
466
+
## Tool Input Validation Guidelines
467
+
468
+
When implementing or modifying tool input parameter handling in the Inspector:
469
+
470
+
-**Omit optional fields with empty values** - When processing form inputs, omit empty strings or null values for optional parameters, UNLESS the field has an explicit default value in the schema that matches the current value
471
+
-**Preserve explicit default values** - If a field schema contains an explicit default (e.g., `default: null`), and the current value matches that default, include it in the request. This is a meaningful value the tool expects
472
+
-**Always include required fields** - Preserve required field values even when empty, allowing the MCP server to validate and return appropriate error messages
473
+
-**Defer deep validation to the server** - Implement basic field presence checking in the Inspector client, but rely on the MCP server for parameter validation according to its schema
474
+
475
+
These guidelines maintain clean parameter passing and proper separation of concerns between the Inspector client and MCP servers.
476
+
459
477
## License
460
478
461
479
This project is licensed under the MIT License—see the [LICENSE](LICENSE) file for details.
0 commit comments