docs: clarify stdio server behavior and debugging#4128
Open
zuhabul wants to merge 1 commit into
Open
Conversation
Add a new section explaining why uvx-launched servers can appear idle, how stdio transport works, how to sanity-check with initialize JSON-RPC, and how to debug with MCP Inspector. Closes modelcontextprotocol#521 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s top-level documentation to reduce confusion when running MCP servers directly (especially stdio-based servers that appear “idle” when launched without a client), and to provide quick debugging/liveness-check workflows.
Changes:
- Adds a README section explaining why
uvx mcp-server-gittypically shows no output and opens no port (stdio transport behavior). - Documents a manual
initializeJSON-RPC request to sanity-check server liveness. - Adds an MCP Inspector command for interactive debugging and clarifies when to use network transports (e.g., HTTP/SSE).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
+1 to the manual initialize liveness check idea. The MCP Inspector pointer |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Why
Closes #521