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

63 lines
1.5 KiB
Ruby

# frozen_string_literal: true
module MCP
module Content
class Text
attr_reader :text, :annotations, :meta
def initialize(text, annotations: nil, meta: nil)
@text = text
@annotations = annotations
@meta = meta
end
def to_h
{ text: text, annotations: annotations, _meta: meta, type: "text" }.compact
end
end
class Image
attr_reader :data, :mime_type, :annotations, :meta
def initialize(data, mime_type, annotations: nil, meta: nil)
@data = data
@mime_type = mime_type
@annotations = annotations
@meta = meta
end
def to_h
{ data: data, mimeType: mime_type, annotations: annotations, _meta: meta, type: "image" }.compact
end
end
class Audio
attr_reader :data, :mime_type, :annotations, :meta
def initialize(data, mime_type, annotations: nil, meta: nil)
@data = data
@mime_type = mime_type
@annotations = annotations
@meta = meta
end
def to_h
{ data: data, mimeType: mime_type, annotations: annotations, _meta: meta, type: "audio" }.compact
end
end
class EmbeddedResource
attr_reader :resource, :annotations, :meta
def initialize(resource, annotations: nil, meta: nil)
@resource = resource
@annotations = annotations
@meta = meta
end
def to_h
{ resource: resource.to_h, annotations: annotations, _meta: meta, type: "resource" }.compact
end
end
end
end