mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-24 22:44:17 +02:00
9d5ffa86b3Co-authored-by: marvin-context-protocol[bot] <225465937+marvin-context-protocol[bot]@users.noreply.github.com>
217 lines
8.1 KiB
Text
217 lines
8.1 KiB
Text
---
|
|
title: resource
|
|
sidebarTitle: resource
|
|
---
|
|
|
|
# `fastmcp.resources.resource`
|
|
|
|
|
|
Base classes and interfaces for FastMCP resources.
|
|
|
|
## Classes
|
|
|
|
### `ResourceContent` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/resources/resource.py#L39" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
|
|
Canonical wrapper for resource content.
|
|
|
|
This is the internal representation for all resource reads. Users can
|
|
return ResourceContent directly for full control, or return simpler types
|
|
(str, bytes, dict) which will be automatically converted.
|
|
|
|
|
|
**Methods:**
|
|
|
|
#### `from_value` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/resources/resource.py#L69" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
from_value(cls, value: Any, mime_type: str | None = None, meta: dict[str, Any] | None = None) -> ResourceContent
|
|
```
|
|
|
|
Convert any value to ResourceContent, handling serialization.
|
|
|
|
**Args:**
|
|
- `value`: The value to convert. Can be\:
|
|
- ResourceContent\: returned as-is (meta param ignored)
|
|
- str\: text content
|
|
- bytes\: binary content
|
|
- other\: serialized to JSON string
|
|
- `mime_type`: Optional MIME type override. If not provided\:
|
|
- str → "text/plain"
|
|
- bytes → "application/octet-stream"
|
|
- other → "application/json"
|
|
- `meta`: Optional metadata (ignored if value is already ResourceContent)
|
|
|
|
**Returns:**
|
|
- ResourceContent instance
|
|
|
|
|
|
#### `to_mcp_resource_contents` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/resources/resource.py#L110" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
to_mcp_resource_contents(self, uri: AnyUrl | str) -> mcp.types.TextResourceContents | mcp.types.BlobResourceContents
|
|
```
|
|
|
|
Convert to MCP resource contents type.
|
|
|
|
**Args:**
|
|
- `uri`: The URI of the resource (required by MCP types)
|
|
|
|
**Returns:**
|
|
- TextResourceContents for str content, BlobResourceContents for bytes
|
|
|
|
|
|
### `Resource` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/resources/resource.py#L137" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
|
|
Base class for all resources.
|
|
|
|
|
|
**Methods:**
|
|
|
|
#### `from_function` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/resources/resource.py#L158" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
from_function(fn: Callable[..., Any], uri: str | AnyUrl, name: str | None = None, title: str | None = None, description: str | None = None, icons: list[Icon] | None = None, mime_type: str | None = None, tags: set[str] | None = None, annotations: Annotations | None = None, meta: dict[str, Any] | None = None, task: bool | TaskConfig | None = None) -> FunctionResource
|
|
```
|
|
|
|
#### `set_default_mime_type` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/resources/resource.py#L187" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
set_default_mime_type(cls, mime_type: str | None) -> str
|
|
```
|
|
|
|
Set default MIME type if not provided.
|
|
|
|
|
|
#### `set_default_name` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/resources/resource.py#L194" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
set_default_name(self) -> Self
|
|
```
|
|
|
|
Set default name from URI if not provided.
|
|
|
|
|
|
#### `read` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/resources/resource.py#L204" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
read(self) -> str | bytes | ResourceContent
|
|
```
|
|
|
|
Read the resource content.
|
|
|
|
This method must be implemented by subclasses. For backwards compatibility,
|
|
subclasses can return str, bytes, or ResourceContent. However, returning
|
|
str or bytes is deprecated - new code should return ResourceContent.
|
|
|
|
**Returns:**
|
|
- str | bytes | ResourceContent: The resource content. Returning str
|
|
- or bytes is deprecated; prefer ResourceContent for full control
|
|
- over MIME type and metadata.
|
|
|
|
|
|
#### `convert_result` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/resources/resource.py#L218" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
convert_result(self, raw_value: Any) -> ResourceContent
|
|
```
|
|
|
|
Convert a raw return value to ResourceContent.
|
|
|
|
Handles ResourceContent passthrough and converts raw values using mime_type.
|
|
|
|
|
|
#### `to_mcp_resource` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/resources/resource.py#L261" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
to_mcp_resource(self, **overrides: Any) -> SDKResource
|
|
```
|
|
|
|
Convert the resource to an SDKResource.
|
|
|
|
|
|
#### `key` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/resources/resource.py#L286" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
key(self) -> str
|
|
```
|
|
|
|
The globally unique lookup key for this resource.
|
|
|
|
|
|
#### `register_with_docket` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/resources/resource.py#L290" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
register_with_docket(self, docket: Docket) -> None
|
|
```
|
|
|
|
Register this resource with docket for background execution.
|
|
|
|
|
|
#### `add_to_docket` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/resources/resource.py#L296" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
add_to_docket(self, docket: Docket, **kwargs: Any) -> Execution
|
|
```
|
|
|
|
Schedule this resource for background execution via docket.
|
|
|
|
**Args:**
|
|
- `docket`: The Docket instance
|
|
- `fn_key`: Function lookup key in Docket registry (defaults to self.key)
|
|
- `task_key`: Redis storage key for the result
|
|
- `**kwargs`: Additional kwargs passed to docket.add()
|
|
|
|
|
|
### `FunctionResource` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/resources/resource.py#L318" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
|
|
A resource that defers data loading by wrapping a function.
|
|
|
|
The function is only called when the resource is read, allowing for lazy loading
|
|
of potentially expensive data. This is particularly useful when listing resources,
|
|
as the function won't be called until the resource is actually accessed.
|
|
|
|
The function can return:
|
|
- str for text content (default)
|
|
- bytes for binary content
|
|
- other types will be converted to JSON
|
|
|
|
|
|
**Methods:**
|
|
|
|
#### `from_function` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/resources/resource.py#L334" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
from_function(cls, fn: Callable[..., Any], uri: str | AnyUrl, name: str | None = None, title: str | None = None, description: str | None = None, icons: list[Icon] | None = None, mime_type: str | None = None, tags: set[str] | None = None, annotations: Annotations | None = None, meta: dict[str, Any] | None = None, task: bool | TaskConfig | None = None) -> FunctionResource
|
|
```
|
|
|
|
Create a FunctionResource from a function.
|
|
|
|
|
|
#### `read` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/resources/resource.py#L380" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
read(self) -> str | bytes | ResourceContent
|
|
```
|
|
|
|
Read the resource by calling the wrapped function.
|
|
|
|
**Returns:**
|
|
- str | bytes | ResourceContent: The resource content. If the user's
|
|
- function returns str, bytes, dict, etc., it will be wrapped
|
|
- in ResourceContent. Nested Resource reads may return raw types.
|
|
|
|
|
|
#### `register_with_docket` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/resources/resource.py#L400" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
register_with_docket(self, docket: Docket) -> None
|
|
```
|
|
|
|
Register this resource with docket for background execution.
|
|
|
|
FunctionResource registers the underlying function, which has the user's
|
|
Depends parameters for docket to resolve.
|
|
|