ruby-sdk/docs
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Koichi ITO 7e507f2963 [Doc] Document the client's ping answers and the stdio request limit
## 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.
2026-09-12 00:02:36 +09:00
..
_client [Doc] Document the client's ping answers and the stdio request limit 2026-09-12 00:02:36 +09:00
_extensions [Doc] Align the Docs Page Names With the MCP Specification 2026-08-22 18:07:38 +09:00
_includes [Doc] Replace the theme attribution in the nav footer 2026-08-24 16:45:55 +09:00
_preview Add a rake docs:preview task serving the docs site locally 2026-08-25 12:36:54 +09:00
_sass Move the Documentation From README.md to the Documentation Site 2026-08-21 13:24:04 +09:00
_server [Doc] Document the client's ping answers and the stdio request limit 2026-09-12 00:02:36 +09:00
assets Move the Documentation From README.md to the Documentation Site 2026-08-21 13:24:04 +09:00
latest Add API documentation with GitHub Pages deployment 2025-11-21 12:21:38 -06:00
_config.yml Move the Documentation From README.md to the Documentation Site 2026-08-21 13:24:04 +09:00
CNAME [Doc] Add CNAME file to preserve custom domain across deployments 2026-03-30 13:27:58 +09:00
examples.md Move the Documentation From README.md to the Documentation Site 2026-08-21 13:24:04 +09:00
favicon.svg Move the Documentation From README.md to the Documentation Site 2026-08-21 13:24:04 +09:00
Gemfile Add a rake docs:preview task serving the docs site locally 2026-08-25 12:36:54 +09:00
index.md [Doc] Align the Docs Page Names With the MCP Specification 2026-08-22 18:07:38 +09:00
installation.md [Doc] Explain when the HTTP client needs event_stream_parser 2026-09-06 03:22:32 +09:00
protocol-versions.md [Doc] Align the Docs Page Names With the MCP Specification 2026-08-22 18:07:38 +09:00