OzMcp.Structs.ReadResourceResult (OzMcp v0.9.0)

Copy Markdown View Source

Helper module used to build ReadResourceResult structure.

(MCP protocol: 2025-11-25)

Short example:

%ReadResourceResult{}
  |> ReadResourceResult.contents([
    %TextResourceContents{}
    |> TextResourceContents.uri("file:///logs/app.log")
    |> TextResourceContents.text("INFO App started")
  ])
  |> ReadResourceResult.build()

Result:

%{contents: [%{text: "INFO App started", uri: "file:///logs/app.log"}]}

Long example:

%ReadResourceResult{}
  |> ReadResourceResult.contents([
    %TextResourceContents{}
    |> TextResourceContents.uri("file:///logs/app.log")
    |> TextResourceContents.text("INFO App started"),
    %BlobResourceContents{}
    |> BlobResourceContents.uri("file:///assets/logo.png")
    |> BlobResourceContents.blob("iVBORw0KGgoAAAANSUhEUg==")
    |> BlobResourceContents.mime_type("image/png")
  ])
  |> ReadResourceResult._meta(%{"key" => "value"})
  |> ReadResourceResult.extras(%{"etag" => "abc123", "cached" => false})
  |> ReadResourceResult.build()

Result:

%{
  :_meta => %{"key" => "value"},
  :contents => [
    %{text: "INFO App started", uri: "file:///logs/app.log"},
    %{
      uri: "file:///assets/logo.png",
      blob: "iVBORw0KGgoAAAANSUhEUg==",
      mimeType: "image/png"
    }
  ],
  "cached" => false,
  "etag" => "abc123"
}

Specification: ReadResourceResult

Fields

FieldSetterTypeRequired
contentscontents/2[contents()]yes
_meta_meta/2mapno
extrasextras/2mapno

Summary

Types

contents()

@type contents() :: OzMcp.Structs.ResourceContents.t()

t()

@type t() :: %OzMcp.Structs.ReadResourceResult{
  _meta: map() | nil,
  contents: [contents()],
  extras: map() | nil
}

Functions

build(struct)

@spec build(t()) :: map()

contents(struct, value)

@spec contents(t(), [contents()]) :: t()

extras(struct, value)

@spec extras(t(), map() | nil) :: t()