OzMcp.Structs.ResourceTemplate (OzMcp v0.9.0)

Copy Markdown View Source

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

FieldSetterTypeRequired
namename/2stringyes
titletitle/2stringno
descriptiondescription/2stringno
mimeTypemime_type/2stringno
_meta_meta/2mapno
iconsicons/2list of OzMcp.Structs.Icon.t/0no
annotationsannotations/2OzMcp.Structs.Annotations.t/0no
uriTemplateuri_template/2stringyes
required_scopesrequired_scopes/2list of scopes, never sentno
extrasextras/2mapno

Summary

Types

t()

@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

annotations(struct, value)

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

build(struct)

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

description(struct, value)

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

extras(struct, value)

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

icons(struct, value)

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

mime_type(struct, value)

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

name(struct, value)

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

required_scopes(struct, value)

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

title(struct, value)

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

uri_template(struct, value)

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