# `OzMcp.Structs.ReadResourceResult`
[🔗](https://github.com/oz-elixir/oz_mcp/blob/v0.9.0/lib/oz_mcp/structs/read_resource_result.ex#L1)

Helper module used to build `ReadResourceResult` structure.

_(MCP protocol: 2025-11-25)_

## Short example:

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

Result:

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

## Long example:

```elixir
%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:

```elixir
%{
  :_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](https://modelcontextprotocol.io/specification/2025-11-25/schema#readresourceresult)

## Fields

| Field | Setter | Type | Required |
|---|---|---|---|
| `contents` | `contents/2` | [contents()] | yes |
| `_meta` | `_meta/2` | map | no |
| `extras` | `extras/2` | map | no |

# `contents`

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

# `t`

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

# `build`

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

# `contents`

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

# `extras`

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

---

*Consult [api-reference.md](api-reference.md) for complete listing*
