bbe637612b
## Motivation and Context The MCP specification defines `notifications/progress` for reporting incremental progress during long-running tool operations. The Ruby SDK did not yet support this, so tools had no way to send progress updates to clients. This caused the `tools-call-with-progress` conformance test to fail. This adds an `MCP::ServerContext` wrapper that provides a `report_progress` method on `server_context`. Tools call `server_context.report_progress(value, total:, message:)` to send notifications back to the client. The method is a no-op when no `progressToken` was provided, so tools can call it unconditionally without checking for a token. This design is consistent with the TypeScript and Python SDKs, which provide progress reporting through a context object rather than a separate parameter. On the client side, `Client#call_tool` now accepts a `progress_token:` parameter that sets `_meta.progressToken` in the request. Ref: https://modelcontextprotocol.io/specification/latest/server/utilities/progress ## How Has This Been Tested? Added comprehensive tests in `test/mcp/server_progress_test.rb` covering `notify_progress`, tool integration with progress, block-defined tools, `**kwargs` tools, and no-op behavior without a token. Added client tests for `progress_token:` parameter inclusion and omission. Added `test/mcp/server_context_test.rb` test for non-Hash `server_context` preservation when `_meta` is present. Conformance: `tools-call-with-progress` removed from expected failures. ## Breaking Change `server_context` is now always an `MCP::ServerContext` instance when passed to tools, even if the server has no context configured. Code that checks `server_context ?` to detect a nil context will need to be updated, as `ServerContext` is always truthy. `ServerContext` delegates method calls to the underlying context object via `method_missing`, so `server_context[:key]` and other accessor patterns continue to work. In practice, this is unlikely to affect users. A tool that declares `server_context:` is opting in to use the context; if the server has no context configured, that is a server configuration issue rather than something the tool should handle with a nil check.
64 lines
2 KiB
Ruby
64 lines
2 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require "test_helper"
|
|
|
|
module MCP
|
|
class ProgressTest < ActiveSupport::TestCase
|
|
class MockTransport < Transport
|
|
attr_reader :notifications
|
|
|
|
def initialize(server)
|
|
super
|
|
@notifications = []
|
|
end
|
|
|
|
def send_notification(method, params = nil)
|
|
@notifications << { method: method, params: params }
|
|
true
|
|
end
|
|
|
|
def send_response(response); end
|
|
def open; end
|
|
def close; end
|
|
def handle_request(request); end
|
|
end
|
|
|
|
setup do
|
|
@server = Server.new(name: "test_server")
|
|
@transport = MockTransport.new(@server)
|
|
@server.transport = @transport
|
|
end
|
|
|
|
test "#report is a no-op when progress_token is nil" do
|
|
progress = Progress.new(server: @server, progress_token: nil)
|
|
progress.report(50, total: 100, message: "halfway")
|
|
|
|
assert_equal 0, @transport.notifications.size
|
|
end
|
|
|
|
test "#report sends notification when progress_token is present" do
|
|
progress = Progress.new(server: @server, progress_token: "token-1")
|
|
progress.report(50, total: 100, message: "halfway")
|
|
|
|
assert_equal 1, @transport.notifications.size
|
|
notification = @transport.notifications.first
|
|
assert_equal Methods::NOTIFICATIONS_PROGRESS, notification[:method]
|
|
assert_equal "token-1", notification[:params]["progressToken"]
|
|
assert_equal 50, notification[:params]["progress"]
|
|
assert_equal 100, notification[:params]["total"]
|
|
assert_equal "halfway", notification[:params]["message"]
|
|
end
|
|
|
|
test "#report omits total and message when not provided" do
|
|
progress = Progress.new(server: @server, progress_token: "token-1")
|
|
progress.report(50)
|
|
|
|
assert_equal 1, @transport.notifications.size
|
|
notification = @transport.notifications.first
|
|
assert_equal "token-1", notification[:params]["progressToken"]
|
|
assert_equal 50, notification[:params]["progress"]
|
|
refute notification[:params].key?("total")
|
|
refute notification[:params].key?("message")
|
|
end
|
|
end
|
|
end
|