Back to Fastmcp

tasks

docs/python-sdk/fastmcp-utilities-tasks.mdx

3.4.0b12.0 KB
Original Source

fastmcp.utilities.tasks

Task configuration primitives for FastMCP components.

Classes

TaskMeta <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/fastmcp_slim/fastmcp/utilities/tasks.py#L22" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

Metadata for task-augmented execution requests.

Attributes:

  • ttl: Client-requested TTL in milliseconds. If None, uses server default.
  • fn_key: Docket routing key. Auto-derived from component name if None.

TaskConfig <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/fastmcp_slim/fastmcp/utilities/tasks.py#L35" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

Configuration for MCP background task execution.

Controls how a component handles task-augmented requests:

  • forbidden: Component does not support task execution.
  • optional: Component supports both synchronous and task execution.
  • required: Component requires task execution.

Methods:

from_bool <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/fastmcp_slim/fastmcp/utilities/tasks.py#L49" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
from_bool(cls, value: bool) -> TaskConfig

Convert a boolean task flag to a TaskConfig.

supports_tasks <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/fastmcp_slim/fastmcp/utilities/tasks.py#L53" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
supports_tasks(self) -> bool

Check if this component supports task execution.

validate_function <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/fastmcp_slim/fastmcp/utilities/tasks.py#L57" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
validate_function(self, fn: Callable[..., Any], name: str) -> None

Validate that a function is compatible with this task config.