Helper module used to build ResourceTemplate structure.
(MCP protocol: 2025-11-25)
Short example:
%ResourceTemplate{}
|> ResourceTemplate.uri_template("file:///{+path}")
|> ResourceTemplate.name("Files")
|> ResourceTemplate.build()Result:
%{name: "Files", uriTemplate: "file:///{+path}"}Long example:
%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:
%{
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
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 OzMcp.Structs.Icon.t/0 | no |
annotations | annotations/2 | 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 |
Summary
Types
@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() }
Functions
@spec annotations(t(), OzMcp.Structs.Annotations.t() | nil) :: t()
@spec icons(t(), [OzMcp.Structs.Icon.t()] | nil) :: t()