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

Helper module used to build `ResourceTemplate` structure.

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

## Short example:

```elixir
%ResourceTemplate{}
  |> ResourceTemplate.uri_template("file:///{+path}")
  |> ResourceTemplate.name("Files")
  |> ResourceTemplate.build()
```

Result:

```elixir
%{name: "Files", uriTemplate: "file:///{+path}"}
```

## Long example:

```elixir
%ResourceTemplate{}
  |> ResourceTemplate.uri_template("file:///{+path}")
  |> ResourceTemplate.name("Files")
  |> ResourceTemplate.title("Project files")
  |> ResourceTemplate.description("Access to project files")
  |> ResourceTemplate.mime_type("text/plain")
  |> ResourceTemplate.icons([
    %Icon{}
    |> Icon.src("https://img.com/icon.png")
    |> Icon.mime_type("image/png")
    |> Icon.sizes(["16x16"])
  ])
  |> ResourceTemplate.build()
```

Result:

```elixir
%{
  name: "Files",
  description: "Access to project files",
  title: "Project files",
  icons: [
    %{
      src: "https://img.com/icon.png",
      sizes: ["16x16"],
      mimeType: "image/png"
    }
  ],
  mimeType: "text/plain",
  uriTemplate: "file:///{+path}"
}
```

The `required_scopes` field holds the scopes that a principal must hold to
use the template. OzMcp uses them for the check of `resources/read` and
`resources/subscribe` and for the filter of `resources/templates/list`.
They are never sent to the client.

Specification: [ResourceTemplate](https://modelcontextprotocol.io/specification/2025-11-25/schema#resourcetemplate)

## Fields

| Field | Setter | Type | Required |
|---|---|---|---|
| `name` | `name/2` | string | yes |
| `title` | `title/2` | string | no |
| `description` | `description/2` | string | no |
| `mimeType` | `mime_type/2` | string | no |
| `_meta` | `_meta/2` | map | no |
| `icons` | `icons/2` | list of `t:OzMcp.Structs.Icon.t/0` | no |
| `annotations` | `annotations/2` | `t:OzMcp.Structs.Annotations.t/0` | no |
| `uriTemplate` | `uri_template/2` | string | yes |
| `required_scopes` | `required_scopes/2` | list of scopes, never sent | no |
| `extras` | `extras/2` | map | no |

# `t`

```elixir
@type t() :: %OzMcp.Structs.ResourceTemplate{
  _meta: map() | nil,
  annotations: OzMcp.Structs.Annotations.t() | nil,
  description: String.t() | nil,
  extras: map() | nil,
  icons: [OzMcp.Structs.Icon.t()] | nil,
  mimeType: String.t() | nil,
  name: String.t(),
  required_scopes: [String.t()],
  title: String.t() | nil,
  uriTemplate: String.t()
}
```

# `annotations`

```elixir
@spec annotations(t(), OzMcp.Structs.Annotations.t() | nil) :: t()
```

# `build`

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

# `description`

```elixir
@spec description(t(), String.t() | nil) :: t()
```

# `extras`

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

# `icons`

```elixir
@spec icons(t(), [OzMcp.Structs.Icon.t()] | nil) :: t()
```

# `mime_type`

```elixir
@spec mime_type(t(), String.t() | nil) :: t()
```

# `name`

```elixir
@spec name(t(), String.t()) :: t()
```

# `required_scopes`

```elixir
@spec required_scopes(t(), [String.t()]) :: t()
```

# `title`

```elixir
@spec title(t(), String.t() | nil) :: t()
```

# `uri_template`

```elixir
@spec uri_template(t(), String.t()) :: t()
```

---

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