mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-30 11:12:08 +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)
130 lines
4.1 KiB
Text
130 lines
4.1 KiB
Text
---
|
|
title: Prompts as Tools
|
|
sidebarTitle: Prompts as Tools
|
|
description: Expose prompts to tool-only clients
|
|
icon: message-lines
|
|
tag: NEW
|
|
---
|
|
|
|
import { VersionBadge } from '/snippets/version-badge.mdx'
|
|
|
|
<VersionBadge version="3.0.0" />
|
|
|
|
Some MCP clients only support tools. They cannot list or get prompts directly because they lack prompt protocol support. The `PromptsAsTools` transform bridges this gap by generating tools that provide access to your server's prompts.
|
|
|
|
When you add `PromptsAsTools` to a server, it creates two tools that clients can call instead of using the prompt protocol:
|
|
|
|
- **`list_prompts`** returns JSON describing all available prompts and their arguments
|
|
- **`get_prompt`** renders a specific prompt with provided arguments
|
|
|
|
This means any client that can call tools can now access prompts, even if the client has no native prompt support.
|
|
|
|
## Basic Usage
|
|
|
|
Pass your FastMCP server to `PromptsAsTools` when adding the transform. The generated tools route through the server at runtime, which means all server middleware — auth, visibility, rate limiting — applies to prompt operations automatically, exactly as it would for direct `prompts/get` calls.
|
|
|
|
<Note>
|
|
`PromptsAsTools` (and `ResourcesAsTools`) should be applied to a FastMCP server instance, not a raw Provider. The generated tools call back into the server's middleware chain at runtime, so they need a server to route through. If you want to expose only a subset of prompts, create a dedicated FastMCP server for those prompts and apply the transform there.
|
|
</Note>
|
|
|
|
```python
|
|
from fastmcp import FastMCP
|
|
from fastmcp.server.transforms import PromptsAsTools
|
|
|
|
mcp = FastMCP("My Server")
|
|
|
|
@mcp.prompt
|
|
def analyze_code(code: str, language: str = "python") -> str:
|
|
"""Analyze code for potential issues."""
|
|
return f"Analyze this {language} code:\n{code}"
|
|
|
|
@mcp.prompt
|
|
def explain_concept(concept: str) -> str:
|
|
"""Explain a programming concept."""
|
|
return f"Explain: {concept}"
|
|
|
|
# Add the transform - creates list_prompts and get_prompt tools
|
|
mcp.add_transform(PromptsAsTools(mcp))
|
|
```
|
|
|
|
Clients now see three items: whatever tools you defined directly, plus `list_prompts` and `get_prompt`.
|
|
|
|
## Listing Prompts
|
|
|
|
The `list_prompts` tool returns JSON with metadata for each prompt, including its arguments.
|
|
|
|
```python
|
|
result = await client.call_tool("list_prompts", {})
|
|
prompts = json.loads(result.data)
|
|
# [
|
|
# {
|
|
# "name": "analyze_code",
|
|
# "description": "Analyze code for potential issues.",
|
|
# "arguments": [
|
|
# {"name": "code", "description": null, "required": true},
|
|
# {"name": "language", "description": null, "required": false}
|
|
# ]
|
|
# },
|
|
# {
|
|
# "name": "explain_concept",
|
|
# "description": "Explain a programming concept.",
|
|
# "arguments": [
|
|
# {"name": "concept", "description": null, "required": true}
|
|
# ]
|
|
# }
|
|
#]
|
|
```
|
|
|
|
Each argument includes:
|
|
- `name`: The argument name
|
|
- `description`: Optional description from type hints or docstrings
|
|
- `required`: Whether the argument must be provided
|
|
|
|
## Getting Prompts
|
|
|
|
The `get_prompt` tool accepts a prompt name and optional arguments dict. It returns the rendered prompt as JSON with a messages array.
|
|
|
|
```python
|
|
# Prompt with required and optional arguments
|
|
result = await client.call_tool(
|
|
"get_prompt",
|
|
{
|
|
"name": "analyze_code",
|
|
"arguments": {
|
|
"code": "x = 1\nprint(x)",
|
|
"language": "python"
|
|
}
|
|
}
|
|
)
|
|
|
|
response = json.loads(result.data)
|
|
# {
|
|
# "messages": [
|
|
# {
|
|
# "role": "user",
|
|
# "content": "Analyze this python code:\nx = 1\nprint(x)"
|
|
# }
|
|
# ]
|
|
# }
|
|
```
|
|
|
|
If a prompt has no arguments, you can omit the `arguments` field or pass an empty dict:
|
|
|
|
```python
|
|
result = await client.call_tool(
|
|
"get_prompt",
|
|
{"name": "simple_prompt"}
|
|
)
|
|
```
|
|
|
|
## Message Format
|
|
|
|
Rendered prompts return a messages array following the standard MCP format. Each message includes:
|
|
- `role`: The message role ("user" or "assistant")
|
|
- `content`: The message text content
|
|
|
|
Multi-message prompts are supported - the array will contain all messages in order.
|
|
|
|
## Binary Content
|
|
|
|
Unlike resources, prompts always return text content. There is no binary encoding needed.
|