ruby-sdk/lib/mcp/resource/contents.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

45 lines
907 B
Ruby

# frozen_string_literal: true
module MCP
class Resource
class Contents
attr_reader :uri, :mime_type, :meta
def initialize(uri:, mime_type: nil, meta: nil)
@uri = uri
@mime_type = mime_type
@meta = meta
end
def to_h
{ uri: uri, mimeType: mime_type, _meta: meta }.compact
end
end
class TextContents < Contents
attr_reader :text
def initialize(text:, uri:, mime_type:, meta: nil)
super(uri: uri, mime_type: mime_type, meta: meta)
@text = text
end
def to_h
super.merge(text: text)
end
end
class BlobContents < Contents
attr_reader :data
def initialize(data:, uri:, mime_type:, meta: nil)
super(uri: uri, mime_type: mime_type, meta: meta)
@data = data
end
def to_h
super.merge(blob: data)
end
end
end
end