Align modern envelope validation with the finalized spec

## Motivation and Context

Two deviations from the finalized 2026-07-28 specification in the SEP-2575 envelope validation,
both introduced against the frozen SEP text and overtaken by post-final spec changes:

1. `clientInfo` was treated as required. Spec PR modelcontextprotocol/modelcontextprotocol#3002 made it
optional (clients SHOULD include it unless configured not to), and the TypeScript and Python SDKs validate only
the `protocolVersion` + `clientCapabilities` pair.
A conformant client configured not to identify itself was rejected.

2. A missing or mistyped envelope answered `-32600` Invalid Request.
The spec maps missing required envelope fields to `-32602` Invalid params, and both reference SDKs answer
with `-32602` naming the offending keys.

Fixing these also corrects the era classification to match the reference SDKs: a request claims
the modern lifecycle when `_meta` carries `io.modelcontextprotocol/protocolVersion`
(the TypeScript envelope claim and the Python `_has_modern_envelope` are both single-key checks),
and a claimed-but-incomplete envelope is now validated and rejected with `-32602` naming
the missing keys instead of silently flowing through the legacy path. Legacy `_meta` usage without
the claim key (`progressToken`, trace context) is classified exactly as before.

Unchanged on purpose: the era-lock violations keep their codes (`-32600` for a modern envelope on
a legacy-locked session, `-32022` for `initialize` on a modern-locked one), matching the Python SDK.

## How Has This Been Tested?

`test/mcp/request_envelope_test.rb` now covers: classification by the claim key alone,
a claimed-but-incomplete envelope staying modern, parsing without the optional `clientInfo`
(reader returns `nil`), `-32602` with the offending key names for a missing `clientCapabilities`
and for mistyped required and optional fields.

`test/mcp/server_test.rb` covers the dispatch-level behavior: a claimed
but incomplete envelope answers `-32602` naming the missing key, an envelope without `clientInfo` is
served with `server_context.client_info` reading `nil`, and a claim-less request on
a modern-locked session answers `-32602` naming the required keys.
The stdio and Streamable HTTP transport tests assert the new code on their envelope-requirement paths.

## Breaking Changes

None for conforming clients. Requests that were already rejected change error code
(`-32600` to `-32602`, HTTP status 400 unchanged), and requests carrying the `protocolVersion` claim key
with an incomplete envelope are now rejected as the spec mandates instead of being served as legacy requests.
Envelopes without `clientInfo`, previously rejected, now succeed.
This commit is contained in:
Koichi ITO 2026-08-08 03:03:47 +09:00
commit f39b1bf4aa
4 changed files with 109 additions and 31 deletions

View file

@ -12,8 +12,9 @@ module MCP
assert_equal "io.modelcontextprotocol/logLevel", RequestEnvelope::LOG_LEVEL_META_KEY
end
test ".modern? returns true when the full required triple is present" do
test ".modern? returns true when the protocolVersion claim key is present" do
assert RequestEnvelope.modern?(modern_params)
assert RequestEnvelope.modern?({ _meta: { "io.modelcontextprotocol/protocolVersion": "2026-07-28" } })
end
test ".modern? returns true for string keys" do
@ -28,11 +29,13 @@ module MCP
assert RequestEnvelope.modern?(params)
end
test ".modern? returns false for a partial triple" do
test ".modern? stays true for a claimed but incomplete envelope" do
# A claimed envelope must be validated by `parse!` (`-32602`), never silently served as legacy,
# matching the TypeScript and Python classifiers.
params = modern_params
params[:_meta].delete(:"io.modelcontextprotocol/clientCapabilities")
refute RequestEnvelope.modern?(params)
assert RequestEnvelope.modern?(params)
end
test ".modern? returns false for legacy _meta entries such as progressToken" do
@ -75,18 +78,34 @@ module MCP
assert_equal "2025-11-25", error.error_data[:requested]
end
test ".parse! raises an invalid request error when the triple is incomplete" do
test ".parse! accepts an envelope without the optional clientInfo" do
# `clientInfo` became optional after the SEP was finalized (spec PR #3002);
# a conformant client configured not to identify itself must not be rejected.
params = modern_params
params[:_meta].delete(:"io.modelcontextprotocol/clientInfo")
envelope = RequestEnvelope.parse!(params)
assert_nil envelope.client_info
assert_equal "2026-07-28", envelope.protocol_version
assert_equal({ elicitation: {} }, envelope.client_capabilities)
end
test ".parse! raises Invalid params naming the missing key when clientCapabilities is absent" do
params = modern_params
params[:_meta].delete(:"io.modelcontextprotocol/clientCapabilities")
error = assert_raises(Server::RequestHandlerError) do
RequestEnvelope.parse!(params)
end
assert_equal :invalid_request, error.error_type
assert_equal :invalid_params, error.error_type
assert_equal JsonRpcHandler::ErrorCode::INVALID_PARAMS, error.error_code
assert_includes error.message, "io.modelcontextprotocol/clientCapabilities"
refute_includes error.message, "io.modelcontextprotocol/protocolVersion"
end
test ".parse! raises an invalid request error when a triple member has the wrong type" do
test ".parse! raises Invalid params when a required field has the wrong type" do
params = modern_params
params[:_meta][:"io.modelcontextprotocol/clientCapabilities"] = "not-a-hash"
@ -94,7 +113,20 @@ module MCP
RequestEnvelope.parse!(params)
end
assert_equal :invalid_request, error.error_type
assert_equal :invalid_params, error.error_type
assert_equal JsonRpcHandler::ErrorCode::INVALID_PARAMS, error.error_code
end
test ".parse! raises Invalid params when the optional clientInfo has the wrong type" do
params = modern_params
params[:_meta][:"io.modelcontextprotocol/clientInfo"] = "not-a-hash"
error = assert_raises(Server::RequestHandlerError) do
RequestEnvelope.parse!(params)
end
assert_equal :invalid_params, error.error_type
assert_includes error.message, "io.modelcontextprotocol/clientInfo"
end
private

View file

@ -617,7 +617,7 @@ module MCP
])
refute responses[0].key?(:error)
assert_equal JsonRpcHandler::ErrorCode::INVALID_REQUEST, responses[1].dig(:error, :code)
assert_equal JsonRpcHandler::ErrorCode::INVALID_PARAMS, responses[1].dig(:error, :code)
end
test "#send_request raises on a modern-locked session" do

View file

@ -5425,7 +5425,7 @@ module MCP
))
assert_equal 400, response[0]
assert_equal(-32600, JSON.parse(response[2][0]).dig("error", "code"))
assert_equal(-32602, JSON.parse(response[2][0]).dig("error", "code"))
end
test "modern POST maps a missing client capability to 400 with -32021" do

View file

@ -295,7 +295,30 @@ module MCP
assert_equal "2027-01-01", response.dig(:error, :data, :requested)
end
test "#handle treats a partial modern triple as a legacy request" do
test "#handle rejects a claimed but incomplete envelope with -32602 naming the missing key" do
# A request carrying the `protocolVersion` claim key must be validated, never silently served as legacy:
# the spec maps missing required envelope fields to Invalid params, and the TypeScript and Python classifiers
# answer the same way.
server = Server.new(name: "modern_test", tools: [])
server.define_tool(name: "modern_tool") { Tool::Response.new([{ type: "text", text: "ok" }]) }
response = server.handle({
jsonrpc: "2.0",
method: "tools/call",
id: 1,
params: {
name: "modern_tool",
arguments: {},
_meta: { "io.modelcontextprotocol/protocolVersion": "2026-07-28" },
},
})
assert_equal JsonRpcHandler::ErrorCode::INVALID_PARAMS, response.dig(:error, :code)
assert_includes response.dig(:error, :message), "io.modelcontextprotocol/clientCapabilities"
end
test "#handle serves an envelope without the optional clientInfo" do
# `clientInfo` became optional after the SEP was finalized (spec PR #3002).
server = Server.new(name: "modern_test", tools: [])
received_context = nil
server.define_tool(name: "modern_tool") do |server_context:|
@ -310,12 +333,17 @@ module MCP
params: {
name: "modern_tool",
arguments: {},
_meta: { "io.modelcontextprotocol/protocolVersion": "2026-07-28" },
_meta: {
"io.modelcontextprotocol/protocolVersion": "2026-07-28",
"io.modelcontextprotocol/clientCapabilities": { elicitation: {} },
},
},
})
refute_nil response[:result]
refute_predicate received_context, :modern?
assert_predicate received_context, :modern?
assert_nil received_context.client_info
assert_equal({ elicitation: {} }, received_context.client_capabilities)
end
test "#handle requires the envelope for requests on a modern-locked session" do
@ -328,7 +356,8 @@ module MCP
session: session,
)
assert_equal JsonRpcHandler::ErrorCode::INVALID_REQUEST, response.dig(:error, :code)
assert_equal JsonRpcHandler::ErrorCode::INVALID_PARAMS, response.dig(:error, :code)
assert_includes response.dig(:error, :message), "io.modelcontextprotocol/protocolVersion"
end
test "#handle rejects initialize on a modern-locked session with -32022" do