Back to Fastmcp

aggregate

docs/python-sdk/fastmcp-server-providers-aggregate.mdx

3.2.43.3 KB
Original Source

fastmcp.server.providers.aggregate

AggregateProvider for combining multiple providers into one.

This module provides AggregateProvider, a utility class that presents multiple providers as a single unified provider. Useful when you want to combine custom providers without creating a full FastMCP server.

Example: ```python from fastmcp.server.providers import AggregateProvider

# Combine multiple providers into one
combined = AggregateProvider()
combined.add_provider(provider1)
combined.add_provider(provider2, namespace="api")  # Tools become "api_foo"

# Use like any other provider
tools = await combined.list_tools()
```

Classes

AggregateProvider <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/aggregate.py#L46" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

Utility provider that combines multiple providers into one.

Components are aggregated from all providers. For get_* operations, providers are queried in parallel and the highest version is returned.

When adding providers with a namespace, wrap_transform() is used to apply the Namespace transform. This means namespace transformation is handled by the wrapped provider, not by AggregateProvider.

Errors from individual providers are logged and skipped (graceful degradation).

Methods:

add_provider <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/aggregate.py#L78" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
add_provider(self, provider: Provider) -> None

Add a provider with optional namespace.

If the provider is a FastMCP server, it's automatically wrapped in FastMCPProvider to ensure middleware is invoked correctly.

Args:

  • provider: The provider to add.
  • namespace: Optional namespace prefix. When set:
  • Tools become "namespace_toolname"
  • Resources become "protocol://namespace/path"
  • Prompts become "namespace_promptname"

get_app_tool <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/aggregate.py#L192" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
get_app_tool(self, app_name: str, tool_name: str) -> Tool | None

Query all child providers for an app tool.

get_tool_by_hash <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/aggregate.py#L205" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
get_tool_by_hash(self, tool_hash: str, tool_name: str) -> Tool | None

Query all child providers for a tool matching a hash.

get_tasks <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/aggregate.py#L290" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
get_tasks(self) -> Sequence[FastMCPComponent]

Get all task-eligible components from all providers.

lifespan <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/aggregate.py#L303" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
lifespan(self) -> AsyncIterator[None]

Combine lifespans of all providers.