modelcontextprotocol/ruby-sdk
Watch
1
0
Fork
You've already forked ruby-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ruby-sdk/docs/_client/index.md
Koichi ITO c9d36b04bf [Doc] Align the Docs Page Names With the MCP Specification 
Three pages carried names the 2026-07-28 specification does not use: "Multi-Round-Trip Results" for
the pattern the specification titles Multi Round-Trip Requests (MRTR) and serves at basic/patterns/mrtr -
the results are the `InputRequiredResult` wire type, not the feature - plus "Completions" for the utility
the specification titles Completion, and "Notification Subscriptions" for the pattern it titles Subscriptions.
Retitle the three pages to the specification's names, move them to /server/mrtr/ and /client/mrtr/,
/server/completion/, and /server/subscriptions/ following the specification's slugs, update every internal reference,
and keep the URLs published with v1.3.0 working via jekyll-redirect-from.
The Discovery page keeps its title but moves from /server/discovery/ to /server/discover/, matching
the specification's slug and the `server/discover` RPC, with its published URL redirected the same way.
2026-08-22 18:07:38 +09:00

2.3 KiB
Raw Blame History

layout title nav_order permalink redirect_from
default Overview 1 /client/
/building-clients.html
/building-clients/

Building an MCP Client

The MCP::Client class provides an interface for interacting with MCP servers.

This class supports:

  • Lifecycle negotiation and connection via MCP::Client#connect, adopting the modern lifecycle when the server serves it; see Lifecycle
  • Server discovery via the server/discover method (MCP::Client#discover); see Explicit Discovery
  • Liveness check via the ping method (MCP::Client#ping)
  • Tool listing via the tools/list method (MCP::Client#tools)
  • Tool invocation via the tools/call method (MCP::Client#call_tool)
  • Resource listing via the resources/list method (MCP::Client#resources)
  • Resource template listing via the resources/templates/list method (MCP::Client#resource_templates)
  • Resource reading via the resources/read method (MCP::Client#read_resource)
  • Prompt listing via the prompts/list method (MCP::Client#prompts)
  • Prompt retrieval via the prompts/get method (MCP::Client#get_prompt)
  • Completion requests via the completion/complete method (MCP::Client#complete); see Completion
  • Automatic driving of multi round-trip input_required results once on_elicitation, on_sampling, or on_roots handlers are registered; see Multi Round-Trip Requests
  • Cancellation of in-flight requests via the cancellation: keyword; see Cancellation
  • Cursor-based page iteration on the list_* methods and whole-collection fetching with the max_pages guard; see Pagination
  • Automatic JSON-RPC 2.0 message formatting
  • UUID request ID generation

Clients are initialized with a transport layer instance that handles the low-level communication mechanics. Authorization is handled by the transport layer; see Authorization.

Tool Objects

The client provides a wrapper class for tools returned by the server:

  • MCP::Client::Tool - Represents a single tool with its metadata

This class provides easy access to tool properties like name, description, input schema, and output schema.