docs: document the ping utility with examples - #1106
Open
alexhancock wants to merge 1 commit into
Open
Conversation
Add a Ping section to the README covering both directions of the utility: constructing and sending a PingRequest via send_request, and the automatic default handler response (with an override example for custom liveness logic). Links to the MCP ping spec. Ping was the only non-experimental feature lacking user-facing documentation and an example.
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
1 participant
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.
What
Adds a Ping section to the README, covering both directions of the ping utility:
PingRequestand sending it viasend_request(client→server and server→client), with a note that a returnedOkconfirms the peer is reachable.rmcpanswers incoming pings automatically via the defaultpinghandler, with an example of overriding it for custom liveness logic.Why
Ping was the only non-experimental feature lacking user-facing documentation and an example. Every other feature in the SDK's supported surface is already documented with examples; this closes the remaining gap.
Notes
Documentation-only change (README). The code examples use the existing public API (
PingRequest,ClientRequest/ServerRequest,send_request, and theServerHandler/ClientHandlerpingmethod).