mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-21 04:54:17 +02:00
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: Jeremiah Lowin <jlowin@users.noreply.github.com> Co-authored-by: Marvin Context Protocol <41898282+Marvin Context Protocol@users.noreply.github.com> Co-authored-by: voidborne-d <voidborne-d@users.noreply.github.com> Co-authored-by: marvin-context-protocol[bot] <225465937+marvin-context-protocol[bot]@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: d 🔹 <258577966+voidborne-d@users.noreply.github.com> Co-authored-by: Jeremiah Lowin <153965+jlowin@users.noreply.github.com> Co-authored-by: nightcityblade <nightcityblade@gmail.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Bill Easton <strawgate@users.noreply.github.com> Co-authored-by: Sumanshu Nankana <sumanshunankana@gmail.com> Co-authored-by: Eric Robinson <ericrobinson@indeed.com> Co-authored-by: Martim Santos <martimfasantos@gmail.com> Co-authored-by: d 🔹 <liusway405@gmail.com> Co-authored-by: Matthieu B <66959271+mtthidoteu@users.noreply.github.com> Co-authored-by: Sascha Buehrle <47737812+saschabuehrle@users.noreply.github.com> Co-authored-by: Hakancan <142545736+hkc5@users.noreply.github.com> Co-authored-by: nightcityblade <jackchen@haloailabs.com> Co-authored-by: Matt Hallowell <17804673+mhallo@users.noreply.github.com> Co-authored-by: nate nowack <thrast36@gmail.com> Co-authored-by: Bill Easton <williamseaston@gmail.com> Co-authored-by: Marcus Shu <46469249+shulkx@users.noreply.github.com> Co-authored-by: Rushabh Doshi <radoshi@gmail.com> Co-authored-by: AIKAWA Shigechika <shige@aikawa.jp> Co-authored-by: Jeremy Simon <simonjer805@gmail.com> Co-authored-by: Miguel Miranda Dias <7780875+pandego@users.noreply.github.com> Co-authored-by: Anthony James Padavano <padavano.anthony@gmail.com> Co-authored-by: Mostafa Kamal <hiremostafa@gmail.com> Fix auto-close MRE script posting comment without closing (#3386) Fix WorkOS token scope verification bypass 🤖 Generated with Codex (#3407) Fix initialize McpError fallthrough 🤖 Generated with Codex (#3413) Fix transform arg collisions with passthrough params (#3431) Fix get_* returning None when latest version is disabled (#3439) Fix get_* returning None when latest version is disabled (#3421) Fix server lifespan overlap teardown (#3415) Fix $ref output schema object detection regression (#3420) resolved annotations (#3429) Fix async partial callables rejected by iscoroutinefunction (#3438) Fix async partial callables rejected by iscoroutinefunction (#3423) fix: add version to components (#3458) fix: use intent-based flag for OIDC scope patch in load_access_token (#3465) Fixes #3461 fix: normalize Google scope shorthands and surface valid_scopes (#3477) fix: resolve ty 0.0.23 type-checking errors and bump pin (#3481) fix: shield lifespan teardown from cancellation (#3480) fix: forward custom_route endpoints from mounted servers (#3462) fix updates _get_additional_http_routes() to traverse providers, Fixes #3457 fix: remove hardcoded version from CLI help text (#3456) fix: monty 0.0.8 compatibility, drop external_functions from constructor (#3468) fix: task test teardown hanging 5s per test (#3499) Closes #3498 fix: validate workspace path is a directory before cursor install (#3440) Fixes #3426 fix: handle re.error from malformed URI templates in build_regex (#3501) fix: reject empty/OIDC-only required_scopes in AzureProvider (#3503) fix: restrict $ref resolution to local refs only (SSRF/LFI) (#3502) fix warnings and timeouts (#3504) close upgrade check issue when build passes (#3505) Closes #3484 fix: URL-encode path params to prevent SSRF/path traversal (GHSA-vv7q-7jx5-f767) (#3507) fix: prevent path traversal in skill download (#3493) fix: prefer IdP-granted scopes over client-requested scopes in OAuthProxy (#3492) fix: remove unrelated transform and http.py changes from PR scope fix: remove forced follow_redirects from httpx_client_factory calls (#3496) fix: stop passing follow_redirects to httpx_client_factory fix: restore follow_redirects=True for custom httpx client factories Closes #3509 fix: CSRF double-submit cookie check in consent flow (#3519) fix: validate server names in install commands (#3522) fix: use raw strings for regex in pytest.raises match (#3523) fix: reject refresh tokens used as Bearer access tokens (#3524) fix: route ResourcesAsTools/PromptsAsTools through server middleware (#3495) fix: resolve Pyright "Module is not callable" on @tool, @resource, @prompt decorators (#3540) fix: filter warnings by message in KEY_PREFIX test (#3549) fix: suppress output schema for ToolResult subclass annotations (#3548) fix: increase sleep duration in proxy cache tests (#3567) fix: store absolute token expiry to prevent stale expires_in on reload (#3572) fix: preserve tool properties named 'title' during schema compression (#3582) Fix loopback redirect URI port matching per RFC 8252 §7.3 (#3589) Fix app tool routing: visibility check and middleware propagation (#3591) Fix query parameter serialization to respect OpenAPI explode/style settings (#3595) Fix dev apps form: union types, textarea support, JSON parsing (#3597) fix(google): replace deprecated /oauth2/v1/tokeninfo with /oauth2/v3/userinfo (#3603) fix: resolve EntraOBOToken dependency injection through MultiAuth (#3609) fix(docs): correct misleading stateless_http header (#3622) fix: filesystem provider import machinery (#3626) Closes #3625 (issues 2, 3, 6) fix: recover StdioTransport after subprocess exits (#3630) fix(server): preserve mounted tool task metadata (#3632) fix: scope deprecation warning filter to FastMCPDeprecationWarning (#3649) fix imports, add PrefabAppConfig (#3650) fix: resolve CurrentFastMCP/ctx.fastmcp to child server in mounted background tasks (#3651) Fix blocking docs issues: chart imports, Select API, Rx consistency (#3652) closed by default (#3657) Fix prompt caching middleware missing wrap/unwrap round-trip (#3666) fix: serialize object query params per OpenAPI style/explode rules (#3662) Fixes #2857 fix: HTTP request headers not accessible in background task workers (#3631) fix: restore HTTP headers in worker execution path for background tasks (#3681) fix: strip discriminator after dereferencing schemas (#3682) fix: remove stale ty:ignore directives for ty 0.0.26 (#3684) Fix docs gaps in app provider pages (#3690) fix: dev apps log panel UX improvements (#3698) fix dev server empty string args (#3700)
321 lines
11 KiB
Text
321 lines
11 KiB
Text
---
|
|
title: base
|
|
sidebarTitle: base
|
|
---
|
|
|
|
# `fastmcp.server.providers.base`
|
|
|
|
|
|
Base Provider class for dynamic MCP components.
|
|
|
|
This module provides the `Provider` abstraction for providing tools,
|
|
resources, and prompts dynamically at runtime.
|
|
|
|
Example:
|
|
```python
|
|
from fastmcp import FastMCP
|
|
from fastmcp.server.providers import Provider
|
|
from fastmcp.tools import Tool
|
|
|
|
class DatabaseProvider(Provider):
|
|
def __init__(self, db_url: str):
|
|
super().__init__()
|
|
self.db = Database(db_url)
|
|
|
|
async def _list_tools(self) -> list[Tool]:
|
|
rows = await self.db.fetch("SELECT * FROM tools")
|
|
return [self._make_tool(row) for row in rows]
|
|
|
|
async def _get_tool(self, name: str) -> Tool | None:
|
|
row = await self.db.fetchone("SELECT * FROM tools WHERE name = ?", name)
|
|
return self._make_tool(row) if row else None
|
|
|
|
mcp = FastMCP("Server", providers=[DatabaseProvider(db_url)])
|
|
```
|
|
|
|
|
|
## Classes
|
|
|
|
### `Provider` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/base.py#L51" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
|
|
Base class for dynamic component providers.
|
|
|
|
Subclass and override whichever methods you need. Default implementations
|
|
return empty lists / None, so you only need to implement what your provider
|
|
supports.
|
|
|
|
|
|
**Methods:**
|
|
|
|
#### `transforms` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/base.py#L76" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
transforms(self) -> list[Transform]
|
|
```
|
|
|
|
All transforms applied to components from this provider.
|
|
|
|
|
|
#### `add_transform` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/base.py#L80" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
add_transform(self, transform: Transform) -> None
|
|
```
|
|
|
|
Add a transform to this provider.
|
|
|
|
Transforms modify components (tools, resources, prompts) as they flow
|
|
through the provider. They're applied in order - first added is innermost.
|
|
|
|
**Args:**
|
|
- `transform`: The transform to add.
|
|
|
|
|
|
#### `wrap_transform` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/base.py#L100" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
wrap_transform(self, transform: Transform) -> Provider
|
|
```
|
|
|
|
Return a new provider with this transform applied (immutable).
|
|
|
|
Unlike add_transform() which mutates this provider, wrap_transform()
|
|
returns a new provider that wraps this one. The original provider
|
|
is unchanged.
|
|
|
|
This is useful when you want to apply transforms without side effects,
|
|
such as adding the same provider to multiple aggregators with different
|
|
namespaces.
|
|
|
|
**Args:**
|
|
- `transform`: The transform to apply.
|
|
|
|
**Returns:**
|
|
- A new provider that wraps this one with the transform applied.
|
|
|
|
|
|
#### `list_tools` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/base.py#L136" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
list_tools(self) -> Sequence[Tool]
|
|
```
|
|
|
|
List tools with all transforms applied.
|
|
|
|
Applies transforms sequentially: base → transforms (in order).
|
|
Each transform receives the result from the previous transform.
|
|
Components may be marked as disabled but are NOT filtered here -
|
|
filtering happens at the server level to allow session transforms to override.
|
|
|
|
**Returns:**
|
|
- Transformed sequence of tools (including disabled ones).
|
|
|
|
|
|
#### `get_tool` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/base.py#L152" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
get_tool(self, name: str, version: VersionSpec | None = None) -> Tool | None
|
|
```
|
|
|
|
Get tool by transformed name with all transforms applied.
|
|
|
|
Note: This method does NOT filter disabled components. The Server
|
|
(FastMCP) performs enabled filtering after all transforms complete,
|
|
allowing session-level transforms to override provider-level disables.
|
|
|
|
**Args:**
|
|
- `name`: The transformed tool name to look up.
|
|
- `version`: Optional version filter. If None, returns highest version.
|
|
|
|
**Returns:**
|
|
- The tool if found (may be marked disabled), None if not found.
|
|
|
|
|
|
#### `get_app_tool` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/base.py#L178" 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
|
|
```
|
|
|
|
Look up an app-visible tool by original name, bypassing transforms.
|
|
|
|
Searches for a tool named ``tool_name`` tagged with the given app
|
|
name. Skips the transform chain entirely.
|
|
|
|
**Returns:**
|
|
- The tool if found and tagged with the given app name, else None.
|
|
|
|
|
|
#### `list_resources` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/base.py#L204" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
list_resources(self) -> Sequence[Resource]
|
|
```
|
|
|
|
List resources with all transforms applied.
|
|
|
|
Components may be marked as disabled but are NOT filtered here.
|
|
|
|
|
|
#### `get_resource` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/base.py#L214" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
get_resource(self, uri: str, version: VersionSpec | None = None) -> Resource | None
|
|
```
|
|
|
|
Get resource by transformed URI with all transforms applied.
|
|
|
|
Note: This method does NOT filter disabled components. The Server
|
|
(FastMCP) performs enabled filtering after all transforms complete.
|
|
|
|
**Args:**
|
|
- `uri`: The transformed resource URI to look up.
|
|
- `version`: Optional version filter. If None, returns highest version.
|
|
|
|
**Returns:**
|
|
- The resource if found (may be marked disabled), None if not found.
|
|
|
|
|
|
#### `list_resource_templates` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/base.py#L239" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
list_resource_templates(self) -> Sequence[ResourceTemplate]
|
|
```
|
|
|
|
List resource templates with all transforms applied.
|
|
|
|
Components may be marked as disabled but are NOT filtered here.
|
|
|
|
|
|
#### `get_resource_template` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/base.py#L249" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
get_resource_template(self, uri: str, version: VersionSpec | None = None) -> ResourceTemplate | None
|
|
```
|
|
|
|
Get resource template by transformed URI with all transforms applied.
|
|
|
|
Note: This method does NOT filter disabled components. The Server
|
|
(FastMCP) performs enabled filtering after all transforms complete.
|
|
|
|
**Args:**
|
|
- `uri`: The transformed template URI to look up.
|
|
- `version`: Optional version filter. If None, returns highest version.
|
|
|
|
**Returns:**
|
|
- The template if found (may be marked disabled), None if not found.
|
|
|
|
|
|
#### `list_prompts` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/base.py#L276" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
list_prompts(self) -> Sequence[Prompt]
|
|
```
|
|
|
|
List prompts with all transforms applied.
|
|
|
|
Components may be marked as disabled but are NOT filtered here.
|
|
|
|
|
|
#### `get_prompt` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/base.py#L286" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
get_prompt(self, name: str, version: VersionSpec | None = None) -> Prompt | None
|
|
```
|
|
|
|
Get prompt by transformed name with all transforms applied.
|
|
|
|
Note: This method does NOT filter disabled components. The Server
|
|
(FastMCP) performs enabled filtering after all transforms complete.
|
|
|
|
**Args:**
|
|
- `name`: The transformed prompt name to look up.
|
|
- `version`: Optional version filter. If None, returns highest version.
|
|
|
|
**Returns:**
|
|
- The prompt if found (may be marked disabled), None if not found.
|
|
|
|
|
|
#### `get_tasks` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/base.py#L444" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
get_tasks(self) -> Sequence[FastMCPComponent]
|
|
```
|
|
|
|
Return components that should be registered as background tasks.
|
|
|
|
Override to customize which components are task-eligible.
|
|
Default calls list_* methods, applies provider transforms, and filters
|
|
for components with task_config.mode != 'forbidden'.
|
|
|
|
Used by the server during startup to register functions with Docket.
|
|
|
|
|
|
#### `lifespan` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/base.py#L489" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
lifespan(self) -> AsyncIterator[None]
|
|
```
|
|
|
|
User-overridable lifespan for custom setup and teardown.
|
|
|
|
Override this method to perform provider-specific initialization
|
|
like opening database connections, setting up external resources,
|
|
or other state management needed for the provider's lifetime.
|
|
|
|
The lifespan scope matches the server's lifespan - code before yield
|
|
runs at startup, code after yield runs at shutdown.
|
|
|
|
|
|
#### `enable` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/base.py#L518" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
enable(self) -> Self
|
|
```
|
|
|
|
Enable components matching all specified criteria.
|
|
|
|
Adds a visibility transform that marks matching components as enabled.
|
|
Later transforms override earlier ones, so enable after disable makes
|
|
the component enabled.
|
|
|
|
With only=True, switches to allowlist mode - first disables everything,
|
|
then enables matching components.
|
|
|
|
**Args:**
|
|
- `names`: Component names or URIs to enable.
|
|
- `keys`: Component keys to enable (e.g., {"tool\:my_tool@v1"}).
|
|
- `version`: Component version spec to enable (e.g., VersionSpec(eq="v1") or
|
|
VersionSpec(gte="v2")). Unversioned components will not match.
|
|
- `tags`: Enable components with these tags.
|
|
- `components`: Component types to include (e.g., {"tool", "prompt"}).
|
|
- `only`: If True, ONLY enable matching components (allowlist mode).
|
|
|
|
**Returns:**
|
|
- Self for method chaining.
|
|
|
|
|
|
#### `disable` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/providers/base.py#L567" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
disable(self) -> Self
|
|
```
|
|
|
|
Disable components matching all specified criteria.
|
|
|
|
Adds a visibility transform that marks matching components as disabled.
|
|
Components can be re-enabled by calling enable() with matching criteria
|
|
(the later transform wins).
|
|
|
|
**Args:**
|
|
- `names`: Component names or URIs to disable.
|
|
- `keys`: Component keys to disable (e.g., {"tool\:my_tool@v1"}).
|
|
- `version`: Component version spec to disable (e.g., VersionSpec(eq="v1") or
|
|
VersionSpec(gte="v2")). Unversioned components will not match.
|
|
- `tags`: Disable components with these tags.
|
|
- `components`: Component types to include (e.g., {"tool", "prompt"}).
|
|
|
|
**Returns:**
|
|
- Self for method chaining.
|
|
|