template

fastmcp.resources.template

Resource template functionality.

Functions

build_regex

build_regex(template: str) -> re.Pattern

match_uri_template

match_uri_template(uri: str, uri_template: str) -> dict[str, str] | None

Classes

ResourceTemplate

A template for dynamically creating resources.

Methods:

enable

enable(self) -> None

disable

disable(self) -> None

from_function

from_function(fn: Callable[..., Any], uri_template: str, name: str | None = None, title: str | None = None, description: str | None = None, mime_type: str | None = None, tags: set[str] | None = None, enabled: bool | None = None, annotations: Annotations | None = None, meta: dict[str, Any] | None = None) -> FunctionResourceTemplate

set_default_mime_type

set_default_mime_type(cls, mime_type: str | None) -> str

Set default MIME type if not provided.

matches

matches(self, uri: str) -> dict[str, Any] | None

Check if URI matches template and extract parameters.

read

read(self, arguments: dict[str, Any]) -> str | bytes

Read the resource content.

create_resource

create_resource(self, uri: str, params: dict[str, Any]) -> Resource

Create a resource from the template with the given parameters.

to_mcp_template

to_mcp_template(self, **overrides: Any) -> MCPResourceTemplate

Convert the resource template to an MCPResourceTemplate.

from_mcp_template

from_mcp_template(cls, mcp_template: MCPResourceTemplate) -> ResourceTemplate

Creates a FastMCP ResourceTemplate from a raw MCP ResourceTemplate object.

key

key(self) -> str

The key of the component. This is used for internal bookkeeping and may reflect e.g. prefixes or other identifiers. You should not depend on keys having a certain value, as the same tool loaded from different hierarchies of servers may have different keys.

FunctionResourceTemplate

A template for dynamically creating resources.

Methods:

read

read(self, arguments: dict[str, Any]) -> str | bytes

Read the resource content.

from_function

from_function(cls, fn: Callable[..., Any], uri_template: str, name: str | None = None, title: str | None = None, description: str | None = None, mime_type: str | None = None, tags: set[str] | None = None, enabled: bool | None = None, annotations: Annotations | None = None, meta: dict[str, Any] | None = None) -> FunctionResourceTemplate

Create a template from a function.