Skip to content

Commit 500d247

Browse files
authored
Merge pull request #525 from koic/align_docs_page_names_with_the_spec
[Doc] Align the Docs Page Names With the MCP Specification
2 parents fcb1ac9 + c9d36b0 commit 500d247

21 files changed

Lines changed: 55 additions & 45 deletions

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Detailed guides are available at https://ruby.sdk.modelcontextprotocol.io.
99
- Build [MCP servers](https://ruby.sdk.modelcontextprotocol.io/server/) that expose tools, prompts, and resources to any MCP host
1010
- Build [MCP clients](https://ruby.sdk.modelcontextprotocol.io/client/) that connect to any MCP server, with automatic lifecycle negotiation and OAuth 2.1 authorization
1111
- Speak every standard transport: stdio and Streamable HTTP (including SSE), with a Rails integration
12-
- Cover the full protocol surface: server-to-client requests, multi round-trip results, notifications, progress, logging, cancellation, completions, and pagination
12+
- Cover the full protocol surface: server-to-client requests, multi round-trip requests, notifications, progress, logging, cancellation, completions, and pagination
1313

1414
## Installation
1515

docs/_client/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ This class supports:
2525
- Resource reading via the `resources/read` method (`MCP::Client#read_resource`)
2626
- Prompt listing via the `prompts/list` method (`MCP::Client#prompts`)
2727
- Prompt retrieval via the `prompts/get` method (`MCP::Client#get_prompt`)
28-
- Completion requests via the `completion/complete` method (`MCP::Client#complete`); see [Completions](/server/completions/)
28+
- Completion requests via the `completion/complete` method (`MCP::Client#complete`); see [Completion](/server/completion/)
2929
- Automatic driving of multi round-trip `input_required` results once `on_elicitation`, `on_sampling`,
30-
or `on_roots` handlers are registered; see [Multi-Round-Trip Results](/client/multi-round-trip-results/)
30+
or `on_roots` handlers are registered; see [Multi Round-Trip Requests](/client/mrtr/)
3131
- Cancellation of in-flight requests via the `cancellation:` keyword; see [Cancellation](/client/cancellation/)
3232
- Cursor-based page iteration on the `list_*` methods and whole-collection fetching with
3333
the `max_pages` guard; see [Pagination](/client/pagination/)

docs/_client/lifecycle.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ only when the server does not serve the modern lifecycle, or when `mode: :legacy
3232
## Lifecycle Negotiation
3333

3434
`MCP::Client#connect` selects the protocol lifecycle automatically by default: on the bundled
35-
`MCP::Client::HTTP` and `MCP::Client::Stdio` transports it probes [`server/discover`](/server/discovery/) first and adopts
35+
`MCP::Client::HTTP` and `MCP::Client::Stdio` transports it probes [`server/discover`](/server/discover/) first and adopts
3636
the stateless modern lifecycle (MCP 2026-07-28, SEP-2575) when the server serves it, falling back to
3737
the classic `initialize` handshake otherwise. Custom transports whose `connect` does not declare
3838
a `mode:` keyword always receive the classic call shape, unchanged.
@@ -69,7 +69,7 @@ Pass `mode: :legacy` for an immediate return to the previous behavior, or switch
6969
`MCP::Client#discover` sends `server/discover` directly: sessionless capability discovery
7070
that works before (or instead of) `connect`. It returns an `MCP::Client::DiscoverResult` struct
7171
exposing `supported_versions`, `capabilities`, `server_info`, `instructions`, and
72-
the `ttl_ms` / `cache_scope` cache hints; see the server [Discovery](/server/discovery/) page
72+
the `ttl_ms` / `cache_scope` cache hints; see the server [Discovery](/server/discover/) page
7373
for the wire shapes.
7474

7575
```ruby
Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
---
22
layout: default
3-
title: Multi-Round-Trip Results
3+
title: Multi Round-Trip Requests
44
nav_order: 4
5+
redirect_from:
6+
- /client/multi-round-trip-results/
57
---
68

7-
# Multi-Round-Trip Results
9+
# Multi Round-Trip Requests
810

911
MCP 2026-07-28 replaces in-flight server-to-client requests with Multi Round-Trip Requests (SEP-2322): instead of issuing `sampling/createMessage`, `roots/list`,
1012
or `elicitation/create` while a request is being processed, a server may answer with a result whose `resultType` is `"input_required"`, carrying an `inputRequests` map
@@ -57,4 +59,4 @@ Servers on legacy protocol versions never send `resultType`, so existing behavio
5759
## Server Side
5860

5961
Authoring `input_required` results with `InputRequiredResult`, securing `requestState`, `resultType` stamping, and the legacy fulfillment
60-
shim that serves pre-2026 clients are documented on the server [Multi-Round-Trip Results](/server/multi-round-trip-results/) page.
62+
shim that serves pre-2026 clients are documented on the server [Multi Round-Trip Requests](/server/mrtr/) page.

docs/_client/transports.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ a JSON-RPC `-32601` (method not found) error. To handle methods other than `elic
166166

167167
On a [modern](/client/lifecycle/) connection servers cannot send requests at all; the same
168168
registered handlers instead drive the requests embedded in `input_required` results,
169-
as documented on [Multi-Round-Trip Results](/client/multi-round-trip-results/).
169+
as documented on [Multi Round-Trip Requests](/client/mrtr/).
170170

171171
### Server-to-Client Requests (Sampling)
172172

docs/_extensions/capability-extensions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ server = MCP::Server.new(name: "my_server", capabilities: capabilities)
2323
The declared extensions appear in the `initialize` result's `capabilities.extensions`. Extensions the client declared during `initialize` are
2424
readable via `server.client_capabilities[:extensions]` (or `session.client_capabilities[:extensions]` for per-session transports).
2525

26-
On the [modern lifecycle](/server/discovery/#the-stateless-modern-lifecycle), the same declarations appear in the `server/discover` result,
26+
On the [modern lifecycle](/server/discover/#the-stateless-modern-lifecycle), the same declarations appear in the `server/discover` result,
2727
and the client's extensions ride each request's `_meta` envelope instead of an `initialize` handshake.
2828
Inside a handler, `server_context.client_capabilities[:extensions]` reads the current request's declarations
2929
with envelope-first resolution, on either lifecycle.

docs/_server/cancellation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ is never cancellable per the spec.
2020
{: .note }
2121
> Cancellation by notification belongs to the handshake lifecycle, where the session correlates
2222
> `notifications/cancelled` with the in-flight request it targets. Requests of the
23-
> [modern lifecycle](/server/discovery/#the-stateless-modern-lifecycle) are sessionless single POST exchanges, so a separately
23+
> [modern lifecycle](/server/discover/#the-stateless-modern-lifecycle) are sessionless single POST exchanges, so a separately
2424
> POSTed cancel notification cannot reach them; a modern client abandons a request by closing
2525
> the connection instead.
2626
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
---
22
layout: default
3-
title: Completions
3+
title: Completion
44
nav_order: 16
5+
redirect_from:
6+
- /server/completions/
57
---
68

7-
# Completions
9+
# Completion
810

911
MCP spec includes [Completions](https://modelcontextprotocol.io/specification/latest/server/utilities/completion),
1012
which enable servers to provide autocompletion suggestions for prompt arguments and resource URIs.

docs/_server/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,6 @@ If an invalid `protocol_version` value is set, an `ArgumentError` is raised.
201201
The pin scopes the `initialize` handshake, so it accepts handshake versions (`2025-11-25` and earlier) only. Per the SEP-2575 era model,
202202
`2026-07-28` carries its version on every request and has no handshake at all, so there is nothing for a pin to configure there and setting it raises `ArgumentError`;
203203
a client asking `initialize` for a modern version is counter-offered the pinned version (or the latest handshake version), matching the TypeScript and Python SDKs.
204-
Clients reach `2026-07-28` through [`server/discover`](/server/discovery/) and the per-request `_meta` envelope, which the bundled transports serve alongside the handshake with no configuration needed.
204+
Clients reach `2026-07-28` through [`server/discover`](/server/discover/) and the per-request `_meta` envelope, which the bundled transports serve alongside the handshake with no configuration needed.
205205

206206
Be sure to check the [MCP spec](https://modelcontextprotocol.io/specification/versioning) for the protocol version to understand the supported features for the version being set.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
layout: default
33
title: Discovery
44
nav_order: 3
5+
redirect_from:
6+
- /server/discovery/
57
---
68

79
# Discovery

0 commit comments

Comments
 (0)