# frozen_string_literal: true require_relative "client/oauth" require_relative "client/stdio" require_relative "client/http" require_relative "client/paginated_result" require_relative "client/tool" module MCP class Client class ServerError < StandardError attr_reader :code, :data def initialize(message, code:, data: nil) super(message) @code = code @data = data end end class RequestHandlerError < StandardError attr_reader :error_type, :original_error, :request def initialize(message, request, error_type: :internal_error, original_error: nil) super(message) @request = request @error_type = error_type @original_error = original_error end end # Raised when a server response fails client-side validation, e.g., a success response # whose `result` field is missing or has the wrong type. This is distinct from a # server-returned JSON-RPC error, which is raised as `ServerError`. class ValidationError < StandardError; end # Raised when the server responds 404 to a request containing a session ID, # indicating the session has expired. Inherits from `RequestHandlerError` for # backward compatibility with callers that rescue the generic error. Per spec, # clients MUST start a new session with a fresh `initialize` request in response. class SessionExpiredError < RequestHandlerError def initialize(message, request, original_error: nil) super(message, request, error_type: :not_found, original_error: original_error) end end # Initializes a new MCP::Client instance. # # @param transport [Object] The transport object to use for communication with the server. # The transport should be a duck type that responds to `send_request`. See the README for more details. # # @example # transport = MCP::Client::HTTP.new(url: "http://localhost:3000") # client = MCP::Client.new(transport: transport) def initialize(transport:) @transport = transport end # The user may want to access additional transport-specific methods/attributes # So keeping it public attr_reader :transport # The server's `InitializeResult` (protocol version, capabilities, server info, # instructions), as reported by the transport after a successful `connect`. # Returns `nil` before `connect`, after `close`, or when the transport does # not expose a cached handshake result. def server_info transport.server_info if transport.respond_to?(:server_info) end # Performs the MCP `initialize` handshake by delegating to the transport # (e.g. `MCP::Client::HTTP`, `MCP::Client::Stdio`). Returns the server's # `InitializeResult`. # # When the transport does not respond to `:connect`, this is a no-op and # returns `nil`. # # @param client_info [Hash, nil] `{ name:, version: }` identifying the client. # @param protocol_version [String, nil] Protocol version to offer. # @param capabilities [Hash] Capabilities advertised by the client. May include # an `extensions` member per SEP-2133, keyed by reverse-DNS extension identifiers, # e.g. `{ extensions: { "com.example/feature" => {} } }`. # @return [Hash, nil] The server's `InitializeResult`, or `nil` when the transport # does not expose an explicit handshake. # https://modelcontextprotocol.io/specification/2025-11-25/basic/lifecycle#initialization def connect(client_info: nil, protocol_version: nil, capabilities: {}) return unless transport.respond_to?(:connect) transport.connect( client_info: client_info, protocol_version: protocol_version, capabilities: capabilities, ) end # Returns true once `connect` has completed the handshake on the underlying # transport. Transports that do not expose connection state are assumed # connected and return `true`. def connected? return transport.connected? if transport.respond_to?(:connected?) true end # Returns a single page of tools from the server. # # @param cursor [String, nil] Cursor from a previous page response. # @param meta [Hash, nil] Additional `_meta` entries to send with the request, # e.g. SEP-414 trace context (see {MCP::TraceContext}). # @param cancellation [MCP::Cancellation, nil] Optional token; cancelling it sends # `notifications/cancelled` to the server and raises `MCP::CancelledError` from this call. # @return [MCP::Client::ListToolsResult] Result with `tools` (Array) # and `next_cursor` (String or nil). # # @example Iterate all pages # cursor = nil # loop do # page = client.list_tools(cursor: cursor) # page.tools.each { |tool| puts tool.name } # cursor = page.next_cursor # break unless cursor # end def list_tools(cursor: nil, meta: nil, cancellation: nil) params = cursor ? { cursor: cursor } : nil response = request(method: "tools/list", params: params, meta: meta, cancellation: cancellation) result = response["result"] || {} tools = (result["tools"] || []).map do |tool| Tool.new( name: tool["name"], description: tool["description"], input_schema: tool["inputSchema"], output_schema: tool["outputSchema"], ) end ListToolsResult.new(tools: tools, next_cursor: result["nextCursor"], meta: result["_meta"]) end # Returns every tool available on the server. Iterates through all pages automatically # when the server paginates, so the full collection is returned regardless of the server's `page_size` setting. # Use {#list_tools} when you need fine-grained cursor control. # # Each call will make a new request - the result is not cached. # # @param cancellation [MCP::Cancellation, nil] Optional cancellation token. # Cancelling it aborts whichever page is currently in flight; pages already returned are kept, # but the call raises `MCP::CancelledError` instead of returning the partial set. # @return [Array] An array of available tools. # # @example # tools = client.tools # tools.each do |tool| # puts tool.name # end def tools(cancellation: nil) # TODO: consider renaming to `list_all_tools`. fetch_all_pages { |cursor| list_tools(cursor: cursor, cancellation: cancellation) }.flat_map(&:tools) end # Returns a single page of resources from the server. # # @param cursor [String, nil] Cursor from a previous page response. # @param meta [Hash, nil] Additional `_meta` entries to send with the request, # e.g. SEP-414 trace context (see {MCP::TraceContext}). # @param cancellation [MCP::Cancellation, nil] Optional cancellation token. # @return [MCP::Client::ListResourcesResult] Result with `resources` (Array) # and `next_cursor` (String or nil). def list_resources(cursor: nil, meta: nil, cancellation: nil) params = cursor ? { cursor: cursor } : nil response = request(method: "resources/list", params: params, meta: meta, cancellation: cancellation) result = response["result"] || {} ListResourcesResult.new( resources: result["resources"] || [], next_cursor: result["nextCursor"], meta: result["_meta"], ) end # Returns every resource available on the server. Iterates through all pages automatically # when the server paginates, so the full collection is returned regardless of the server's `page_size` setting. # Use {#list_resources} when you need fine-grained cursor control. # # Each call will make a new request - the result is not cached. # # @param cancellation [MCP::Cancellation, nil] Optional cancellation token (see {#tools}). # @return [Array] An array of available resources. def resources(cancellation: nil) # TODO: consider renaming to `list_all_resources`. fetch_all_pages { |cursor| list_resources(cursor: cursor, cancellation: cancellation) }.flat_map(&:resources) end # Returns a single page of resource templates from the server. # # @param cursor [String, nil] Cursor from a previous page response. # @param meta [Hash, nil] Additional `_meta` entries to send with the request, # e.g. SEP-414 trace context (see {MCP::TraceContext}). # @param cancellation [MCP::Cancellation, nil] Optional cancellation token. # @return [MCP::Client::ListResourceTemplatesResult] Result with `resource_templates` # (Array) and `next_cursor` (String or nil). def list_resource_templates(cursor: nil, meta: nil, cancellation: nil) params = cursor ? { cursor: cursor } : nil response = request(method: "resources/templates/list", params: params, meta: meta, cancellation: cancellation) result = response["result"] || {} ListResourceTemplatesResult.new( resource_templates: result["resourceTemplates"] || [], next_cursor: result["nextCursor"], meta: result["_meta"], ) end # Returns every resource template available on the server. Iterates through all pages automatically # when the server paginates, so the full collection is returned regardless of the server's `page_size` setting. # Use {#list_resource_templates} when you need fine-grained cursor control. # # Each call will make a new request - the result is not cached. # # @param cancellation [MCP::Cancellation, nil] Optional cancellation token (see {#tools}). # @return [Array] An array of available resource templates. def resource_templates(cancellation: nil) # TODO: consider renaming to `list_all_resource_templates`. fetch_all_pages { |cursor| list_resource_templates(cursor: cursor, cancellation: cancellation) }.flat_map(&:resource_templates) end # Returns a single page of prompts from the server. # # @param cursor [String, nil] Cursor from a previous page response. # @param meta [Hash, nil] Additional `_meta` entries to send with the request, # e.g. SEP-414 trace context (see {MCP::TraceContext}). # @param cancellation [MCP::Cancellation, nil] Optional cancellation token. # @return [MCP::Client::ListPromptsResult] Result with `prompts` (Array) # and `next_cursor` (String or nil). def list_prompts(cursor: nil, meta: nil, cancellation: nil) params = cursor ? { cursor: cursor } : nil response = request(method: "prompts/list", params: params, meta: meta, cancellation: cancellation) result = response["result"] || {} ListPromptsResult.new( prompts: result["prompts"] || [], next_cursor: result["nextCursor"], meta: result["_meta"], ) end # Returns every prompt available on the server. Iterates through all pages automatically # when the server paginates, so the full collection is returned regardless of the server's `page_size` setting. # Use {#list_prompts} when you need fine-grained cursor control. # # Each call will make a new request - the result is not cached. # # @param cancellation [MCP::Cancellation, nil] Optional cancellation token (see {#tools}). # @return [Array] An array of available prompts. def prompts(cancellation: nil) # TODO: consider renaming to `list_all_prompts`. fetch_all_pages { |cursor| list_prompts(cursor: cursor, cancellation: cancellation) }.flat_map(&:prompts) end # Calls a tool via the transport layer and returns the full response from the server. # # @param name [String] The name of the tool to call. # @param tool [MCP::Client::Tool] The tool to be called. # @param arguments [Object, nil] The arguments to pass to the tool. # @param progress_token [String, Integer, nil] A token to request progress notifications from the server during tool execution. # @param meta [Hash, nil] Additional `_meta` entries to send with the request, # e.g. the W3C Trace Context keys reserved by SEP-414 # (`MCP::TraceContext::TRACEPARENT_META_KEY`, `tracestate`, `baggage`). # `progress_token` takes precedence over a `progressToken` entry in `meta`. # @param cancellation [MCP::Cancellation, nil] Optional cancellation token. Cancelling it from another thread # sends `notifications/cancelled` to the server and raises `MCP::CancelledError` from this call. # @return [Hash] The full JSON-RPC response from the transport. # # @example Call by name # response = client.call_tool(name: "my_tool", arguments: { foo: "bar" }) # content = response.dig("result", "content") # # @example Call with a tool object # tool = client.tools.first # response = client.call_tool(tool: tool, arguments: { foo: "bar" }) # structured_content = response.dig("result", "structuredContent") # # @example Cancellable call # cancellation = MCP::Cancellation.new # Thread.new do # client.call_tool(name: "slow_tool", arguments: {}, cancellation: cancellation) # rescue MCP::CancelledError # # cleanup # end # cancellation.cancel(reason: "user pressed cancel") # # @note # The exact requirements for `arguments` are determined by the transport layer in use. # Consult the documentation for your transport (e.g., MCP::Client::HTTP) for details. def call_tool(name: nil, tool: nil, arguments: nil, progress_token: nil, meta: nil, cancellation: nil) tool_name = name || tool&.name raise ArgumentError, "Either `name:` or `tool:` must be provided." unless tool_name params = { name: tool_name, arguments: arguments } meta_entries = meta ? meta.dup : {} if progress_token meta_entries.delete("progressToken") meta_entries[:progressToken] = progress_token end params[:_meta] = meta_entries unless meta_entries.empty? request(method: "tools/call", params: params, cancellation: cancellation) end # Reads a resource from the server by URI and returns the contents. # # @param uri [String] The URI of the resource to read. # @param meta [Hash, nil] Additional `_meta` entries to send with the request, # e.g. SEP-414 trace context (see {MCP::TraceContext}). # @param cancellation [MCP::Cancellation, nil] Optional cancellation token. # @return [Array] An array of resource contents (text or blob). def read_resource(uri:, meta: nil, cancellation: nil) response = request(method: "resources/read", params: { uri: uri }, meta: meta, cancellation: cancellation) response.dig("result", "contents") || [] end # Gets a prompt from the server by name and returns its details. # # @param name [String] The name of the prompt to get. # @param meta [Hash, nil] Additional `_meta` entries to send with the request, # e.g. SEP-414 trace context (see {MCP::TraceContext}). # @param cancellation [MCP::Cancellation, nil] Optional cancellation token. # @return [Hash] A hash containing the prompt details. def get_prompt(name:, meta: nil, cancellation: nil) response = request(method: "prompts/get", params: { name: name }, meta: meta, cancellation: cancellation) response.fetch("result", {}) end # Requests completion suggestions from the server for a prompt argument or resource template URI. # # @param ref [Hash] The reference, e.g. `{ type: "ref/prompt", name: "my_prompt" }` # or `{ type: "ref/resource", uri: "file:///{path}" }`. # @param argument [Hash] The argument being completed, e.g. `{ name: "language", value: "py" }`. # @param context [Hash, nil] Optional context with previously resolved arguments. # @param meta [Hash, nil] Additional `_meta` entries to send with the request, # e.g. SEP-414 trace context (see {MCP::TraceContext}). # @param cancellation [MCP::Cancellation, nil] Optional cancellation token. # @return [Hash] The completion result with `"values"`, `"hasMore"`, and optionally `"total"`. def complete(ref:, argument:, context: nil, meta: nil, cancellation: nil) params = { ref: ref, argument: argument } params[:context] = context if context response = request(method: "completion/complete", params: params, meta: meta, cancellation: cancellation) response.dig("result", "completion") || { "values" => [], "hasMore" => false } end # Sends a `ping` request to the server to verify the connection is alive. # Per the MCP spec, the server responds with an empty result. # # @param meta [Hash, nil] Additional `_meta` entries to send with the request, # e.g. SEP-414 trace context (see {MCP::TraceContext}). # @param cancellation [MCP::Cancellation, nil] Optional cancellation token. # @return [Hash] An empty hash on success. # @raise [ServerError] If the server returns a JSON-RPC error. # @raise [ValidationError] If the response `result` is missing or not a Hash. # # @example # client.ping # => {} # # @see https://modelcontextprotocol.io/specification/latest/basic/utilities/ping def ping(meta: nil, cancellation: nil) result = request(method: Methods::PING, meta: meta, cancellation: cancellation)["result"] raise ValidationError, "Response validation failed: missing or invalid `result`" unless result.is_a?(Hash) result end private # Walks every page of a list endpoint, following `next_cursor`, and returns # the page results. The `seen` set guards against a server that repeats or # cycles cursors, so the loop always terminates. def fetch_all_pages pages = [] seen = Set.new cursor = nil loop do page = yield(cursor) pages << page next_cursor = page.next_cursor break if next_cursor.nil? || seen.include?(next_cursor) seen << next_cursor cursor = next_cursor end pages end # Merges caller-supplied `meta` entries into the request params as `_meta`, # without mutating the caller's hashes. Per SEP-414, `_meta` carries # request-specific metadata such as W3C trace context (`traceparent`, # `tracestate`, `baggage`); see {MCP::TraceContext}. def request(method:, params: nil, meta: nil, cancellation: nil) params = (params || {}).merge(_meta: meta) if meta && !meta.empty? request_body = { jsonrpc: JsonRpcHandler::Version::V2_0, id: generate_request_id, method: method, } request_body[:params] = params if params response = if cancellation dispatch_with_cancellation(request_body, cancellation) else transport.send_request(request: request_body) end # Guard with `is_a?(Hash)` because custom transports may return non-Hash values. if response.is_a?(Hash) && response.key?("error") error = response["error"] raise ServerError.new(error["message"], code: error["code"], data: error["data"]) end response end # Generates a fresh JSON-RPC request id for an outgoing request. # Ids are an internal concern: the public API never accepts or exposes them, and cancellation is driven through # an `MCP::Cancellation` token instead. def generate_request_id SecureRandom.uuid end # Sends `request_body` while watching `cancellation`. The actual blocking `transport.send_request` runs on # a worker thread; the calling thread waits on a Queue that is woken either by the response or by a cancel signal # (whichever arrives first - matching the server-side `StreamableHTTPTransport#cancel_pending_request` race contract). # # When a cancel wins the race, the calling thread raises `MCP::CancelledError` immediately and the `notifications/cancelled` # dispatch runs fire-and-forget on its own thread. We deliberately do not wait for that dispatch here: the calling thread # must not be blocked by a slow or stalled transport write on the cancel path. # The worker thread is also not force-killed; it stays blocked on the underlying I/O until the server actually responds # (or the transport closes). This is the same trade-off the server-side `StreamableHTTPTransport#send_request` accepts and # is noted in the README's Cancellation section. def dispatch_with_cancellation(request_body, cancellation) unless transport.respond_to?(:send_notification) raise NoMethodError, "Cancellation support requires a transport that responds to `send_notification(notification:)` " \ "so `notifications/cancelled` can be delivered to the peer. The bundled `MCP::Client::Stdio` and `MCP::Client::HTTP` transports " \ "implement this interface; custom transports must add it before passing `cancellation:` to a request method." end cancellation.raise_if_cancelled! request_id = request_body[:id] queue = Queue.new # First-writer-wins gate. Whichever side (worker or on_cancel) flips `completed` first owns the queue's single slot; the loser bails. # This closes the late-cancel window between the worker pushing `:response` and the main thread completing `dispatch_with_cancellation`, # where a callback firing in that gap would otherwise emit a stray `notifications/cancelled` for a request that already succeeded. completion_mutex = Mutex.new completed = false sent_mutex = Mutex.new sent_cond = ConditionVariable.new request_sent = false signal_sent = lambda do sent_mutex.synchronize do unless request_sent request_sent = true sent_cond.broadcast end end end Thread.new do Thread.current.report_on_exception = false begin result = transport.send_request(request: request_body, &signal_sent) completion_mutex.synchronize do next if completed completed = true queue.push([:response, result]) end rescue StandardError => e completion_mutex.synchronize do next if completed completed = true queue.push([:error, e]) end ensure # Unblock any waiting cancel-dispatch thread on completion (or error) # so it does not stall when the transport ignored the block. signal_sent.call end end cancel_hook = cancellation.on_cancel do |reason| should_dispatch = completion_mutex.synchronize do next false if completed completed = true # Wake the waiting thread first, then dispatch the `notifications/cancelled` send on a separate thread. # The wake-first ordering matters because the cancellation callback can run on the worker thread itself # (e.g. a tool that triggers cancel from within `transport.send_request`), and a synchronous `send_notification` # here would deadlock when the worker holds a transport-level mutex. queue.push([:cancelled, reason]) true end next unless should_dispatch Thread.new do Thread.current.report_on_exception = false # Wait for the worker's send-boundary signal before issuing `notifications/cancelled`. Bundled transports raise # the signal via `&on_sent` from inside `send_request`; custom transports that ignore the block still raise it # via the worker's `ensure -> signal_sent.call`, so the loop is bounded by worker termination rather than by wall-clock time. # The previous fixed-duration fallback could release this thread before the worker reached its send-boundary at all, # allowing the cancel to be issued without any prior request commitment - which the spec only covers under # the receiver's MAY-ignore-unknown-id clause and is therefore avoided here. sent_mutex.synchronize do sent_cond.wait(sent_mutex) until request_sent end cancel(request_id: request_id, reason: reason) rescue StandardError # Swallow notification-send failures: the calling thread has already been woken with `:cancelled` above and # is on its way to raising `MCP::CancelledError`. end end tag, payload = queue.pop case tag when :response payload when :error raise payload when :cancelled raise MCP::CancelledError.new(request_id: request_id, reason: payload) end ensure cancellation&.off_cancel(cancel_hook) if cancel_hook end # Sends `notifications/cancelled` to the server for an in-flight request. # Per spec, this is fire-and-forget: the server is expected to stop processing and suppress its response, # with no acknowledgement returned. Driven internally by {#dispatch_with_cancellation} when a request's # `cancellation` token fires. def cancel(request_id:, reason: nil) params = { requestId: request_id } params[:reason] = reason if reason notification = { jsonrpc: JsonRpcHandler::Version::V2_0, method: Methods::NOTIFICATIONS_CANCELLED, params: params, } transport.send_notification(notification: notification) nil end end end