[Doc] Document the client's ping answers and the stdio request limit - #551
Open
koic wants to merge 1 commit into
Open
[Doc] Document the client's ping answers and the stdio request limit#551koic wants to merge 1 commit into
koic wants to merge 1 commit into
Conversation
## Motivation and Context
The client answers server pings automatically, but the docs leave out where that applies and what the stdio transport
does with the other server-to-client requests.
The client Transports page now lists the automatic ping answer among the things the stdio transport handles,
and a note states that `ping` is the only server-to-client request answered there: a wire-level `elicitation/create`
or `sampling/createMessage` is ignored over stdio, so a server that sends one waits for an answer that never comes,
while the SEP-2322 `input_required` route works on every transport and keeps `on_elicitation` and `on_sampling` handlers
working over stdio. Without this note, the only trace of the limitation is a hung tool call.
The client Ping page now says that over HTTP a ping reaches the client only on a stream that is already open
and that the client never opens one to receive pings, so a server can only ping a client that has a stream open.
Registering `on_server_request("ping")` moves to the end of the section as the advanced option it is, together with
its side effect of opening the GET listening stream on `connect`.
The client overview mentions the automatic answer next to `MCP::Client#ping`,
and the server Ping page's Client Side section points at it.
## How Has This Been Tested?
Documentation only; the linked headings and pages exist.
## Breaking Changes
None.
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.
Motivation and Context
The client answers server pings automatically, but the docs leave out where that applies and what the stdio transport does with the other server-to-client requests.
The client Transports page now lists the automatic ping answer among the things the stdio transport handles, and a note states that
pingis the only server-to-client request answered there: a wire-levelelicitation/createorsampling/createMessageis ignored over stdio, so a server that sends one waits for an answer that never comes, while the SEP-2322input_requiredroute works on every transport and keepson_elicitationandon_samplinghandlers working over stdio. Without this note, the only trace of the limitation is a hung tool call.The client Ping page now says that over HTTP a ping reaches the client only on a stream that is already open and that the client never opens one to receive pings, so a server can only ping a client that has a stream open. Registering
on_server_request("ping")moves to the end of the section as the advanced option it is, together with its side effect of opening the GET listening stream onconnect.The client overview mentions the automatic answer next to
MCP::Client#ping, and the server Ping page's Client Side section points at it.How Has This Been Tested?
Documentation only; the linked headings and pages exist.
Breaking Changes
None.
Types of changes
Checklist