`fastmcp.server.providers.local_provider.decorators.resources`

Resource decorator mixin for LocalProvider.

This module provides the ResourceDecoratorMixin class that adds resource and template registration functionality to LocalProvider.

Classes

Mixin class providing resource decorator functionality for LocalProvider.

This mixin contains all methods related to:

Methods:

python

add_resource(self: LocalProvider, resource: Resource | ResourceTemplate | Callable[..., Any]) -> Resource | ResourceTemplate

Add a resource to this provider's storage.

Accepts either a Resource/ResourceTemplate object or a decorated function with fastmcp metadata.

python

add_template(self: LocalProvider, template: ResourceTemplate) -> ResourceTemplate

Add a resource template to this provider's storage.

python

resource(self: LocalProvider, uri: str) -> Callable[[F], F]

Decorator to register a function as a resource.

If the URI contains parameters (e.g. "resource://{param}") or the function has parameters, it will be registered as a template resource.

Args:

uri: URI for the resource (e.g. "resource://my-resource" or "resource://{param}")
name: Optional name for the resource
title: Optional title for the resource
description: Optional description of the resource
icons: Optional icons for the resource
mime_type: Optional MIME type for the resource
tags: Optional set of tags for categorizing the resource
enabled: Whether the resource is enabled (default True). If False, adds to blocklist.
annotations: Optional annotations about the resource's behavior
meta: Optional meta information about the resource
task: Optional task configuration for background execution
auth: Optional authorization checks for the resource

Returns: