ruby-sdk/docs/_client
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Koichi ITO 0da0291887 [Doc] Explain when the HTTP client needs event_stream_parser
## Motivation and Context

The Installation page names faraday as the example of an optional dependency but leaves out event_stream_parser,
which the HTTP client transport needs as soon as a server answers with SSE. The Transports page documents both gems,
so a reader who starts from Installation learns about the second one only when a streaming response fails to parse.

The Transports page also marks event_stream_parser as "optional, required only for SSE responses",
which reads as a corner case. Whether a response is JSON or SSE is the server's choice, made for each response,
a client must accept both, and this SDK's own server picks SSE by default and always on the modern lifecycle,
so a client written for arbitrary servers needs both gems. Both pages now say so, and the Transports page spells out
the one setup that can leave the gem out: a server known to answer with JSON alone, such as this SDK's server
in JSON response mode serving handshake-lifecycle clients, and no listening stream.

The Installation page shows the faraday-only Gemfile first and then the one that adds event_stream_parser,
so both cases are visible at a glance.

## How Has This Been Tested?

Documentation only; the Gemfile snippets on both pages match.

## Breaking Changes

None.
2026-09-06 03:22:32 +09:00
..
authorization.md Let the embedding application refuse an authorization request 2026-08-31 02:33:10 +09:00
cancellation.md Move the Documentation From README.md to the Documentation Site 2026-08-21 13:24:04 +09:00
index.md [Doc] Align the Docs Page Names With the MCP Specification 2026-08-22 18:07:38 +09:00
lifecycle.md [Doc] Align the Docs Page Names With the MCP Specification 2026-08-22 18:07:38 +09:00
mrtr.md [Doc] Align the Docs Page Names With the MCP Specification 2026-08-22 18:07:38 +09:00
pagination.md Move the Documentation From README.md to the Documentation Site 2026-08-21 13:24:04 +09:00
ping.md Answer server-to-client pings in the client 2026-09-03 16:55:06 +09:00
transports.md [Doc] Explain when the HTTP client needs event_stream_parser 2026-09-06 03:22:32 +09:00