Skip to content

Validate protocol_version value #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,8 @@ This will make all new server instances use the specified protocol version inste
MCP::Server.protocol_version = nil
```

If an invalid `protocol_version` value is set, an `ArgumentError` is raised.

Be sure to check the [MCP spec](https://modelcontextprotocol.io/specification/2025-03-26) for the protocol version to understand the supported features for the version being set.

### Exception Reporting
Expand Down
5 changes: 5 additions & 0 deletions lib/mcp/configuration.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
module MCP
class Configuration
DEFAULT_PROTOCOL_VERSION = "2024-11-05"
SUPPORTED_PROTOCOL_VERSIONS = ["2025-06-18", "2025-03-26", DEFAULT_PROTOCOL_VERSION]

attr_writer :exception_reporter, :instrumentation_callback, :protocol_version, :validate_tool_call_arguments

Expand All @@ -11,6 +12,10 @@ def initialize(exception_reporter: nil, instrumentation_callback: nil, protocol_
@exception_reporter = exception_reporter
@instrumentation_callback = instrumentation_callback
@protocol_version = protocol_version
if protocol_version && !SUPPORTED_PROTOCOL_VERSIONS.include?(protocol_version)
message = "protocol_version must be #{SUPPORTED_PROTOCOL_VERSIONS[0...-1].join(", ")}, or #{SUPPORTED_PROTOCOL_VERSIONS[-1]}"
raise ArgumentError, message
end
unless validate_tool_call_arguments.is_a?(TrueClass) || validate_tool_call_arguments.is_a?(FalseClass)
raise ArgumentError, "validate_tool_call_arguments must be a boolean"
end
Expand Down
20 changes: 14 additions & 6 deletions test/mcp/configuration_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -48,18 +48,18 @@ class ConfigurationTest < ActiveSupport::TestCase
end

test "merges protocol version from other configuration" do
config1 = Configuration.new(protocol_version: "2025-03-27")
config2 = Configuration.new(protocol_version: "2025-03-28")
config1 = Configuration.new(protocol_version: "2025-03-26")
config2 = Configuration.new(protocol_version: "2025-06-18")
config3 = Configuration.new

merged = config1.merge(config2)
assert_equal "2025-03-28", merged.protocol_version
assert_equal "2025-06-18", merged.protocol_version

merged = config1.merge(config3)
assert_equal "2025-03-27", merged.protocol_version
assert_equal "2025-03-26", merged.protocol_version

merged = config3.merge(config1)
assert_equal "2025-03-27", merged.protocol_version
assert_equal "2025-03-26", merged.protocol_version
end

test "defaults validate_tool_call_arguments to true" do
Expand Down Expand Up @@ -96,10 +96,18 @@ class ConfigurationTest < ActiveSupport::TestCase
refute merged.validate_tool_call_arguments
end

test "raises ArgumentError when protocol_version is not a supported value" do
exception = assert_raises(ArgumentError) do
Configuration.new(protocol_version: "1999-12-31")
end
assert_match(/\Aprotocol_version must be/, exception.message)
end

test "raises ArgumentError when validate_tool_call_arguments is not a boolean" do
assert_raises(ArgumentError) do
exception = assert_raises(ArgumentError) do
Configuration.new(validate_tool_call_arguments: "true")
end
assert_equal("validate_tool_call_arguments must be a boolean", exception.message)
end
end
end
2 changes: 1 addition & 1 deletion test/mcp/server_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -804,7 +804,7 @@ def call(message:, server_context: nil)
end

test "server protocol version can be overridden via configuration" do
custom_version = "2025-03-27"
custom_version = "2025-03-26"
configuration = Configuration.new(protocol_version: custom_version)
server = Server.new(name: "test_server", configuration: configuration)

Expand Down