Helper module used to build EmbeddedResource structure.
(MCP protocol: 2025-11-25)
Short example:
%EmbeddedResource{}
|> EmbeddedResource.resource(
%TextResourceContents{}
|> TextResourceContents.uri("file:///logs/app.log")
|> TextResourceContents.text("INFO App started")
)
|> EmbeddedResource.build()Result:
%{
type: "resource",
resource: %{text: "INFO App started", uri: "file:///logs/app.log"}
}Long example:
%EmbeddedResource{}
|> EmbeddedResource.resource(
%BlobResourceContents{}
|> BlobResourceContents.uri("file:///assets/logo.png")
|> BlobResourceContents.blob("iVBORw0KGgoAAAANSUhEUg==")
|> BlobResourceContents.mime_type("image/png")
)
|> EmbeddedResource.annotations(
%Annotations{}
|> Annotations.audience(["assistant"])
)
|> EmbeddedResource._meta(%{"key" => "value"})
|> EmbeddedResource.build()Result:
%{
type: "resource",
resource: %{
uri: "file:///assets/logo.png",
blob: "iVBORw0KGgoAAAANSUhEUg==",
mimeType: "image/png"
},
annotations: %{audience: ["assistant"]},
_meta: %{"key" => "value"}
}Specification: EmbeddedResource
Fields
| Field | Setter | Type | Required |
|---|---|---|---|
resource | resource/2 | resource() | no |
annotations | annotations/2 | OzMcp.Structs.Annotations.t/0 | no |
_meta | _meta/2 | map | no |
Summary
Types
@type resource() :: OzMcp.Structs.ResourceContents.t()
@type t() :: %OzMcp.Structs.EmbeddedResource{ _meta: map() | nil, annotations: OzMcp.Structs.Annotations.t() | nil, resource: resource() }