mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-18 11:39:12 +02:00
ee5f465a82* Initialize 2.14 deprecation removal branch * Remove deprecated FASTMCP_SERVER_ environment variable prefix (#2330) * Remove deprecated Context.get_http_request method (#2332) * Remove fastmcp.Image top-level import (deprecated 2.8.1) (#2334) * Remove test warnings (#2331) * Create new branch and fix issue * Remove deprecated client parameter from FastMCPProxy (#2333) * Remove deprecated run_streamable_http_async method (#2338) * Remove deprecated sse_app method (#2337) * Remove deprecated run_sse_async method (#2335) * Remove deprecated run_sse_async method * Update CLI and tests to use run_http_async(transport="sse") - Change CLI to call run_http_async with transport="sse" instead of run_sse_async - Update test to mock run_http_async with create=True for v1 servers * Revert CLI changes - v1 servers do have run_sse_async - Keep CLI calling run_sse_async() for v1 compatibility - Update test to mock run_sse_async (which exists on v1) * Remove unnecessary type ignore for run_sse_async Method exists on v1 FastMCP class, no type error * Remove unused imports after test deletion * Remove deprecated streamable_http_app method (#2336) * Remove deprecated dependencies parameter from FastMCP constructor (#2340) * Remove output_schema=False support (deprecated 2.11.4) (#2339) * Remove deprecated client parameter from FastMCPProxy (#2333) * Delete deprecated test_output_schema_false.py Tests functionality that has been removed * Remove deprecated BearerAuthProvider module (#2341) * Remove resource_prefix_format="protocol" support (deprecated 2.4.0) (#2342) * Remove resource_prefix_format="protocol" support (fixes #2195) Removes deprecated protocol format (prefix+resource://path) and keeps only path format (resource://prefix/path). Since only one format remains: - Removed resource_prefix_format from settings, FastMCP.__init__, and helpers - Simplified add_resource_prefix, remove_resource_prefix, has_resource_prefix - Removed MountedServer.resource_prefix_format field - Deleted tests for protocol format All resource prefixes now use path format exclusively. * Clean up resource_prefix_format references - Remove from test files - Update documentation to remove protocol format section - Move custom HTTP routes note to mounting section - Remove resource_prefix_format from settings docs * Use inline version note instead of badge for prefix format * Remove obsolete test functions and update docs - Delete test functions that no longer assert anything - Remove proxy.mdx reference to deleted prefix format section * Format error messages per ruff * Remove from_client classmethod (deprecated 2.8.0) (#2343) * Remove deprecated from_client classmethod (fixes #2192) * Remove unused Client import * Remove add_resource_fn method (deprecated 2.7.0) (#2345) * Update SDK * Add missing imports for exclude_args deprecation warning
491 lines
17 KiB
JSON
491 lines
17 KiB
JSON
{
|
|
"$schema": "https://mintlify.com/docs.json",
|
|
"appearance": {
|
|
"default": "system",
|
|
"strict": false
|
|
},
|
|
"background": {
|
|
"color": {
|
|
"dark": "#222831",
|
|
"light": "#EEEEEE"
|
|
},
|
|
"decoration": "gradient"
|
|
},
|
|
"banner": {
|
|
"content": "Join the [FastMCP community](https://discord.gg/uu8dJCgttd)!"
|
|
},
|
|
"colors": {
|
|
"dark": "#f72585",
|
|
"light": "#4cc9f0",
|
|
"primary": "#2d00f7"
|
|
},
|
|
"contextual": {
|
|
"options": [
|
|
"copy",
|
|
"view"
|
|
]
|
|
},
|
|
"description": "The fast, Pythonic way to build MCP servers and clients.",
|
|
"errors": {
|
|
"404": {
|
|
"description": "You\u2019ve wandered outside the context.",
|
|
"redirect": false,
|
|
"title": "Don't panic."
|
|
}
|
|
},
|
|
"favicon": {
|
|
"dark": "/assets/brand/favicon.svg",
|
|
"light": "/assets/brand/favicon.svg"
|
|
},
|
|
"footer": {
|
|
"socials": {
|
|
"discord": "https://discord.gg/uu8dJCgttd",
|
|
"github": "https://github.com/jlowin/fastmcp",
|
|
"website": "https://prefect.ai",
|
|
"x": "https://x.com/fastmcp"
|
|
}
|
|
},
|
|
"integrations": {
|
|
"ga4": {
|
|
"measurementId": "G-64R5W1TJXG"
|
|
}
|
|
},
|
|
"interaction": {
|
|
"drilldown": false
|
|
},
|
|
"logo": {
|
|
"dark": "/assets/brand/wordmark-white.png",
|
|
"light": "/assets/brand/wordmark.png"
|
|
},
|
|
"name": "FastMCP",
|
|
"navbar": {
|
|
"links": [
|
|
{
|
|
"href": "https://fastmcp.cloud",
|
|
"icon": "cloud",
|
|
"label": "FastMCP Cloud"
|
|
},
|
|
{
|
|
"href": "https://discord.gg/uu8dJCgttd",
|
|
"icon": "discord",
|
|
"label": "Discord"
|
|
}
|
|
],
|
|
"primary": {
|
|
"href": "https://github.com/jlowin/fastmcp",
|
|
"type": "github"
|
|
}
|
|
},
|
|
"navigation": {
|
|
"dropdowns": [
|
|
{
|
|
"dropdown": "Documentation",
|
|
"groups": [
|
|
{
|
|
"group": "Get Started",
|
|
"pages": [
|
|
"getting-started/welcome",
|
|
"getting-started/installation",
|
|
"getting-started/quickstart",
|
|
"updates"
|
|
]
|
|
},
|
|
{
|
|
"group": "Servers",
|
|
"pages": [
|
|
"servers/server",
|
|
{
|
|
"group": "Core Components",
|
|
"icon": "toolbox",
|
|
"pages": [
|
|
"servers/tools",
|
|
"servers/resources",
|
|
"servers/prompts"
|
|
]
|
|
},
|
|
{
|
|
"group": "Advanced Features",
|
|
"icon": "stars",
|
|
"pages": [
|
|
"servers/composition",
|
|
"servers/context",
|
|
"servers/elicitation",
|
|
"servers/icons",
|
|
"servers/logging",
|
|
"servers/middleware",
|
|
"servers/progress",
|
|
"servers/proxy",
|
|
"servers/sampling",
|
|
"servers/storage-backends"
|
|
]
|
|
},
|
|
{
|
|
"group": "Authentication",
|
|
"icon": "shield-check",
|
|
"pages": [
|
|
"servers/auth/authentication",
|
|
"servers/auth/token-verification",
|
|
"servers/auth/remote-oauth",
|
|
"servers/auth/oauth-proxy",
|
|
"servers/auth/oidc-proxy",
|
|
"servers/auth/full-oauth-server"
|
|
]
|
|
},
|
|
{
|
|
"group": "Deployment",
|
|
"icon": "rocket",
|
|
"pages": [
|
|
"deployment/running-server",
|
|
"deployment/http",
|
|
"deployment/fastmcp-cloud",
|
|
"deployment/server-configuration"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Clients",
|
|
"pages": [
|
|
{
|
|
"group": "Essentials",
|
|
"icon": "cube",
|
|
"pages": [
|
|
"clients/client",
|
|
"clients/transports"
|
|
]
|
|
},
|
|
{
|
|
"group": "Core Operations",
|
|
"icon": "handshake",
|
|
"pages": [
|
|
"clients/tools",
|
|
"clients/resources",
|
|
"clients/prompts"
|
|
]
|
|
},
|
|
{
|
|
"group": "Advanced Features",
|
|
"icon": "stars",
|
|
"pages": [
|
|
"clients/elicitation",
|
|
"clients/logging",
|
|
"clients/progress",
|
|
"clients/sampling",
|
|
"clients/messages",
|
|
"clients/roots"
|
|
]
|
|
},
|
|
{
|
|
"group": "Authentication",
|
|
"icon": "user-shield",
|
|
"pages": [
|
|
"clients/auth/oauth",
|
|
"clients/auth/bearer"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Integrations",
|
|
"pages": [
|
|
{
|
|
"group": "Authentication",
|
|
"icon": "key",
|
|
"pages": [
|
|
"integrations/auth0",
|
|
"integrations/authkit",
|
|
"integrations/aws-cognito",
|
|
"integrations/azure",
|
|
"integrations/descope",
|
|
"integrations/discord",
|
|
"integrations/github",
|
|
"integrations/scalekit",
|
|
"integrations/google",
|
|
"integrations/workos"
|
|
]
|
|
},
|
|
{
|
|
"group": "Authorization",
|
|
"icon": "shield-check",
|
|
"pages": [
|
|
"integrations/eunomia-authorization",
|
|
"integrations/permit"
|
|
]
|
|
},
|
|
{
|
|
"group": "AI Assistants",
|
|
"icon": "robot",
|
|
"pages": [
|
|
"integrations/chatgpt",
|
|
"integrations/claude-code",
|
|
"integrations/claude-desktop",
|
|
"integrations/cursor",
|
|
"integrations/gemini-cli",
|
|
"integrations/mcp-json-configuration"
|
|
]
|
|
},
|
|
{
|
|
"group": "AI SDKs",
|
|
"icon": "code",
|
|
"pages": [
|
|
"integrations/anthropic",
|
|
"integrations/gemini",
|
|
"integrations/openai"
|
|
]
|
|
},
|
|
{
|
|
"group": "API Integration",
|
|
"icon": "globe",
|
|
"pages": [
|
|
"integrations/fastapi",
|
|
"integrations/openapi"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Patterns",
|
|
"pages": [
|
|
"patterns/tool-transformation",
|
|
"patterns/decorating-methods",
|
|
"patterns/cli",
|
|
"patterns/contrib",
|
|
"patterns/testing"
|
|
]
|
|
},
|
|
{
|
|
"group": "Development",
|
|
"pages": [
|
|
"development/contributing",
|
|
"development/tests",
|
|
"development/releases",
|
|
"development/upgrade-guide",
|
|
"changelog"
|
|
]
|
|
}
|
|
],
|
|
"icon": "book"
|
|
},
|
|
{
|
|
"anchors": [
|
|
{
|
|
"anchor": "Python SDK",
|
|
"icon": "python",
|
|
"pages": [
|
|
"python-sdk/fastmcp-exceptions",
|
|
"python-sdk/fastmcp-mcp_config",
|
|
"python-sdk/fastmcp-settings",
|
|
{
|
|
"group": "fastmcp.cli",
|
|
"pages": [
|
|
"python-sdk/fastmcp-cli-__init__",
|
|
"python-sdk/fastmcp-cli-cli",
|
|
{
|
|
"group": "install",
|
|
"pages": [
|
|
"python-sdk/fastmcp-cli-install-__init__",
|
|
"python-sdk/fastmcp-cli-install-claude_code",
|
|
"python-sdk/fastmcp-cli-install-claude_desktop",
|
|
"python-sdk/fastmcp-cli-install-cursor",
|
|
"python-sdk/fastmcp-cli-install-gemini_cli",
|
|
"python-sdk/fastmcp-cli-install-mcp_json",
|
|
"python-sdk/fastmcp-cli-install-shared"
|
|
]
|
|
},
|
|
"python-sdk/fastmcp-cli-run"
|
|
]
|
|
},
|
|
{
|
|
"group": "fastmcp.client",
|
|
"pages": [
|
|
"python-sdk/fastmcp-client-__init__",
|
|
{
|
|
"group": "auth",
|
|
"pages": [
|
|
"python-sdk/fastmcp-client-auth-__init__",
|
|
"python-sdk/fastmcp-client-auth-bearer",
|
|
"python-sdk/fastmcp-client-auth-oauth"
|
|
]
|
|
},
|
|
"python-sdk/fastmcp-client-client",
|
|
"python-sdk/fastmcp-client-elicitation",
|
|
"python-sdk/fastmcp-client-logging",
|
|
"python-sdk/fastmcp-client-messages",
|
|
"python-sdk/fastmcp-client-oauth_callback",
|
|
"python-sdk/fastmcp-client-progress",
|
|
"python-sdk/fastmcp-client-roots",
|
|
"python-sdk/fastmcp-client-sampling",
|
|
"python-sdk/fastmcp-client-transports"
|
|
]
|
|
},
|
|
{
|
|
"group": "fastmcp.prompts",
|
|
"pages": [
|
|
"python-sdk/fastmcp-prompts-__init__",
|
|
"python-sdk/fastmcp-prompts-prompt",
|
|
"python-sdk/fastmcp-prompts-prompt_manager"
|
|
]
|
|
},
|
|
{
|
|
"group": "fastmcp.resources",
|
|
"pages": [
|
|
"python-sdk/fastmcp-resources-__init__",
|
|
"python-sdk/fastmcp-resources-resource",
|
|
"python-sdk/fastmcp-resources-resource_manager",
|
|
"python-sdk/fastmcp-resources-template",
|
|
"python-sdk/fastmcp-resources-types"
|
|
]
|
|
},
|
|
{
|
|
"group": "fastmcp.server",
|
|
"pages": [
|
|
"python-sdk/fastmcp-server-__init__",
|
|
{
|
|
"group": "auth",
|
|
"pages": [
|
|
"python-sdk/fastmcp-server-auth-__init__",
|
|
"python-sdk/fastmcp-server-auth-auth",
|
|
"python-sdk/fastmcp-server-auth-jwt_issuer",
|
|
"python-sdk/fastmcp-server-auth-middleware",
|
|
"python-sdk/fastmcp-server-auth-oauth_proxy",
|
|
"python-sdk/fastmcp-server-auth-oidc_proxy",
|
|
{
|
|
"group": "providers",
|
|
"pages": [
|
|
"python-sdk/fastmcp-server-auth-providers-__init__",
|
|
"python-sdk/fastmcp-server-auth-providers-auth0",
|
|
"python-sdk/fastmcp-server-auth-providers-aws",
|
|
"python-sdk/fastmcp-server-auth-providers-azure",
|
|
"python-sdk/fastmcp-server-auth-providers-debug",
|
|
"python-sdk/fastmcp-server-auth-providers-descope",
|
|
"python-sdk/fastmcp-server-auth-providers-discord",
|
|
"python-sdk/fastmcp-server-auth-providers-github",
|
|
"python-sdk/fastmcp-server-auth-providers-google",
|
|
"python-sdk/fastmcp-server-auth-providers-in_memory",
|
|
"python-sdk/fastmcp-server-auth-providers-introspection",
|
|
"python-sdk/fastmcp-server-auth-providers-jwt",
|
|
"python-sdk/fastmcp-server-auth-providers-oci",
|
|
"python-sdk/fastmcp-server-auth-providers-scalekit",
|
|
"python-sdk/fastmcp-server-auth-providers-supabase",
|
|
"python-sdk/fastmcp-server-auth-providers-workos"
|
|
]
|
|
},
|
|
"python-sdk/fastmcp-server-auth-redirect_validation"
|
|
]
|
|
},
|
|
"python-sdk/fastmcp-server-context",
|
|
"python-sdk/fastmcp-server-dependencies",
|
|
"python-sdk/fastmcp-server-elicitation",
|
|
"python-sdk/fastmcp-server-http",
|
|
"python-sdk/fastmcp-server-low_level",
|
|
{
|
|
"group": "middleware",
|
|
"pages": [
|
|
"python-sdk/fastmcp-server-middleware-__init__",
|
|
"python-sdk/fastmcp-server-middleware-caching",
|
|
"python-sdk/fastmcp-server-middleware-error_handling",
|
|
"python-sdk/fastmcp-server-middleware-logging",
|
|
"python-sdk/fastmcp-server-middleware-middleware",
|
|
"python-sdk/fastmcp-server-middleware-rate_limiting",
|
|
"python-sdk/fastmcp-server-middleware-timing",
|
|
"python-sdk/fastmcp-server-middleware-tool_injection"
|
|
]
|
|
},
|
|
"python-sdk/fastmcp-server-openapi",
|
|
"python-sdk/fastmcp-server-proxy",
|
|
"python-sdk/fastmcp-server-server"
|
|
]
|
|
},
|
|
{
|
|
"group": "fastmcp.tools",
|
|
"pages": [
|
|
"python-sdk/fastmcp-tools-__init__",
|
|
"python-sdk/fastmcp-tools-tool",
|
|
"python-sdk/fastmcp-tools-tool_manager",
|
|
"python-sdk/fastmcp-tools-tool_transform"
|
|
]
|
|
},
|
|
{
|
|
"group": "fastmcp.utilities",
|
|
"pages": [
|
|
"python-sdk/fastmcp-utilities-__init__",
|
|
"python-sdk/fastmcp-utilities-auth",
|
|
"python-sdk/fastmcp-utilities-cli",
|
|
"python-sdk/fastmcp-utilities-components",
|
|
"python-sdk/fastmcp-utilities-exceptions",
|
|
"python-sdk/fastmcp-utilities-http",
|
|
"python-sdk/fastmcp-utilities-inspect",
|
|
"python-sdk/fastmcp-utilities-json_schema",
|
|
"python-sdk/fastmcp-utilities-json_schema_type",
|
|
"python-sdk/fastmcp-utilities-logging",
|
|
"python-sdk/fastmcp-utilities-mcp_config",
|
|
{
|
|
"group": "mcp_server_config",
|
|
"pages": [
|
|
"python-sdk/fastmcp-utilities-mcp_server_config-__init__",
|
|
{
|
|
"group": "v1",
|
|
"pages": [
|
|
"python-sdk/fastmcp-utilities-mcp_server_config-v1-__init__",
|
|
{
|
|
"group": "environments",
|
|
"pages": [
|
|
"python-sdk/fastmcp-utilities-mcp_server_config-v1-environments-__init__",
|
|
"python-sdk/fastmcp-utilities-mcp_server_config-v1-environments-base",
|
|
"python-sdk/fastmcp-utilities-mcp_server_config-v1-environments-uv"
|
|
]
|
|
},
|
|
"python-sdk/fastmcp-utilities-mcp_server_config-v1-mcp_server_config",
|
|
{
|
|
"group": "sources",
|
|
"pages": [
|
|
"python-sdk/fastmcp-utilities-mcp_server_config-v1-sources-__init__",
|
|
"python-sdk/fastmcp-utilities-mcp_server_config-v1-sources-base",
|
|
"python-sdk/fastmcp-utilities-mcp_server_config-v1-sources-filesystem"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"python-sdk/fastmcp-utilities-openapi",
|
|
"python-sdk/fastmcp-utilities-tests",
|
|
"python-sdk/fastmcp-utilities-types",
|
|
"python-sdk/fastmcp-utilities-ui"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"dropdown": "SDK Reference",
|
|
"icon": "code"
|
|
}
|
|
]
|
|
},
|
|
"redirects": [
|
|
{
|
|
"destination": "/servers/proxy",
|
|
"source": "/patterns/proxy"
|
|
},
|
|
{
|
|
"destination": "/servers/composition",
|
|
"source": "/patterns/composition"
|
|
}
|
|
],
|
|
"search": {
|
|
"prompt": "Search the docs..."
|
|
},
|
|
"styling": {
|
|
"codeblocks": {
|
|
"theme": {
|
|
"dark": "dark-plus",
|
|
"light": "snazzy-light"
|
|
}
|
|
}
|
|
},
|
|
"theme": "almond",
|
|
"thumbnails": {
|
|
"appearance": "light",
|
|
"background": "/assets/brand/thumbnail-background.png"
|
|
}
|
|
}
|