ruby-sdk/test/mcp/tool/response_test.rb
Koichi ITO 0ad9a89d97 Add _meta field to resource, content, and result classes
## Motivation and Context

MCP 2025-11-25 spec defines a `_meta` general field on many types,
but the Ruby SDK only exposed it on `Tool` and `Prompt`.
To attach metadata (e.g. MCP Apps CSP hints on resource contents),
consumers had to subclass existing classes and override `to_h`.

Add a `meta:` keyword argument and `_meta` serialization to:

- `Resource::Contents`, `Resource::TextContents`, `Resource::BlobContents`
- `Resource`, `ResourceTemplate`
- `Content::Text`, `Content::Image`, `Content::Audio`, `Content::EmbeddedResource`
- `Tool::Response` (`CallToolResult`)
- `Prompt::Result` (`GetPromptResult`)

This aligns the Ruby SDK with the Python and TypeScript SDKs, which both expose `_meta` on these types.

Resolves #308.

## How Has This Been Tested?

Added unit tests for each updated class covering two patterns: `_meta` present
(asserts the value is reflected in `to_h[:_meta]`) and `_meta` omitted
(asserts no `:_meta` key in `to_h`, i.e., `.compact` behavior).
All existing tests continue to pass, and `rake rubocop` is clean.

## Breaking Changes

None. All new `meta:` parameters are optional keyword arguments defaulting to `nil`.
The `to_h` output stays backward-compatible because `nil` values are removed by the existing `.compact` call,
so existing callers require no changes.
2026-04-11 15:08:55 +09:00

141 lines
4.4 KiB
Ruby

# frozen_string_literal: true
require "test_helper"
module MCP
class Tool
class ResponseTest < ActiveSupport::TestCase
test "#initialize with content" do
content = [{
type: "text",
text: "Unauthorized",
}]
response = Response.new(content)
assert_equal content, response.content
refute response.error?
end
test "#initialize with content and error set to true" do
content = [{
type: "text",
text: "Unauthorized",
}]
response = Response.new(content, error: true)
assert_equal content, response.content
assert response.error?
end
test "#initialize with content and error explicitly set to false" do
content = [{
type: "text",
text: "Unauthorized",
}]
response = Response.new(content, error: false)
assert_equal content, response.content
refute response.error?
end
test "#initialize with content and structuredContent" do
content = [{
type: "text",
text: "{\"code\":401,\"message\":\"Unauthorized\"}",
}]
structured_content = { code: 401, message: "Unauthorized" }
response = Response.new(content, structured_content: structured_content)
assert_equal content, response.content
assert_equal structured_content, response.structured_content
refute response.error?
end
test "#error? for a standard response" do
response = Response.new(nil, error: false)
refute response.error?
end
test "#error? for an error response" do
response = Response.new(nil, error: true)
assert response.error?
end
test "#to_h for a standard response" do
content = [{
type: "text",
text: "Unauthorized",
}]
response = Response.new(content)
actual = response.to_h
assert_equal [:content, :isError], actual.keys
assert_equal content, actual[:content]
refute actual[:isError]
end
test "#to_h for an error response" do
content = [{
type: "text",
text: "Unauthorized",
}]
response = Response.new(content, error: true)
actual = response.to_h
assert_equal [:content, :isError], actual.keys
assert_equal content, actual[:content]
assert actual[:isError]
end
test "#to_h for a standard response with content and structured content" do
content = [{
type: "text",
text: "{\"code\":401,\"message\":\"Unauthorized\"}",
}]
structured_content = { code: 401, message: "Unauthorized" }
response = Response.new(content, structured_content: structured_content)
actual = response.to_h
assert_equal [:content, :isError, :structuredContent], actual.keys
assert_equal content, actual[:content]
assert_equal structured_content, actual[:structuredContent]
refute actual[:isError]
end
test "#to_h for a standard response with nil content and structured content" do
structured_content = { code: 401, message: "Unauthorized" }
response = Response.new(nil, structured_content: structured_content)
actual = response.to_h
assert_equal [:content, :isError, :structuredContent], actual.keys
assert_equal([], actual[:content])
assert_equal structured_content, actual[:structuredContent]
refute actual[:isError]
end
test "#to_h for a standard response with structured content only" do
structured_content = { code: 401, message: "Unauthorized" }
response = Response.new(structured_content: structured_content)
actual = response.to_h
assert_equal [:content, :isError, :structuredContent], actual.keys
assert_equal([], actual[:content])
assert_equal structured_content, actual[:structuredContent]
refute actual[:isError]
end
test "#to_h includes _meta when present" do
meta = { "application/vnd.ant.mcp-app" => { "csp" => "default-src 'self'" } }
response = Response.new([{ type: "text", text: "ok" }], meta: meta)
actual = response.to_h
assert_equal meta, actual[:_meta]
end
test "#to_h omits _meta when nil" do
response = Response.new([{ type: "text", text: "ok" }])
refute response.to_h.key?(:_meta)
end
end
end
end