mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-09 15:19:10 +02:00
592 lines
21 KiB
JSON
592 lines
21 KiB
JSON
{
|
|
"$schema": "https://mintlify.com/docs.json",
|
|
"appearance": {
|
|
"default": "system",
|
|
"strict": false
|
|
},
|
|
"background": {
|
|
"color": {
|
|
"dark": "#222831",
|
|
"light": "#EEEEEE"
|
|
},
|
|
"decoration": "gradient"
|
|
},
|
|
"banner": {
|
|
"content": "Join us at the inaugural PyAI Conf in San Francisco on March 10th! [Learn More](https://pyai.events?utm_source=gofastmcp)"
|
|
},
|
|
"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://www.prefect.io",
|
|
"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": "Components",
|
|
"icon": "toolbox",
|
|
"pages": [
|
|
"servers/tools",
|
|
"servers/resources",
|
|
"servers/prompts"
|
|
]
|
|
},
|
|
{
|
|
"group": "Providers",
|
|
"icon": "layer-group",
|
|
"pages": [
|
|
"servers/providers/overview",
|
|
"servers/providers/local",
|
|
"servers/providers/filesystem",
|
|
"servers/providers/mounting",
|
|
"servers/providers/namespacing",
|
|
"servers/providers/proxy",
|
|
"servers/providers/custom"
|
|
]
|
|
},
|
|
{
|
|
"group": "Features",
|
|
"icon": "stars",
|
|
"pages": [
|
|
"servers/tasks",
|
|
"servers/context",
|
|
"servers/elicitation",
|
|
"servers/icons",
|
|
"servers/lifespan",
|
|
"servers/logging",
|
|
"servers/middleware",
|
|
"servers/progress",
|
|
"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/tasks",
|
|
"clients/messages",
|
|
"clients/roots"
|
|
]
|
|
},
|
|
{
|
|
"group": "Authentication",
|
|
"icon": "user-shield",
|
|
"pages": [
|
|
"clients/auth/oauth",
|
|
"clients/auth/bearer"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Integrations",
|
|
"pages": [
|
|
{
|
|
"group": "Providers",
|
|
"icon": "globe",
|
|
"pages": [
|
|
"integrations/fastapi",
|
|
"integrations/openapi"
|
|
]
|
|
},
|
|
{
|
|
"group": "Authentication",
|
|
"icon": "key",
|
|
"pages": [
|
|
"integrations/auth0",
|
|
"integrations/authkit",
|
|
"integrations/aws-cognito",
|
|
"integrations/azure",
|
|
"integrations/descope",
|
|
"integrations/discord",
|
|
"integrations/github",
|
|
"integrations/google",
|
|
"integrations/oci",
|
|
"integrations/scalekit",
|
|
"integrations/supabase",
|
|
"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": "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-dependencies",
|
|
"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",
|
|
"python-sdk/fastmcp-cli-tasks"
|
|
]
|
|
},
|
|
{
|
|
"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",
|
|
{
|
|
"group": "sampling",
|
|
"pages": [
|
|
"python-sdk/fastmcp-client-sampling-__init__",
|
|
{
|
|
"group": "handlers",
|
|
"pages": [
|
|
"python-sdk/fastmcp-client-sampling-handlers-__init__",
|
|
"python-sdk/fastmcp-client-sampling-handlers-anthropic",
|
|
"python-sdk/fastmcp-client-sampling-handlers-openai"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"python-sdk/fastmcp-client-tasks",
|
|
"python-sdk/fastmcp-client-transports"
|
|
]
|
|
},
|
|
{
|
|
"group": "fastmcp.prompts",
|
|
"pages": [
|
|
"python-sdk/fastmcp-prompts-__init__",
|
|
"python-sdk/fastmcp-prompts-prompt"
|
|
]
|
|
},
|
|
{
|
|
"group": "fastmcp.resources",
|
|
"pages": [
|
|
"python-sdk/fastmcp-resources-__init__",
|
|
"python-sdk/fastmcp-resources-resource",
|
|
"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-event_store",
|
|
"python-sdk/fastmcp-server-http",
|
|
"python-sdk/fastmcp-server-lifespan",
|
|
"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"
|
|
]
|
|
},
|
|
{
|
|
"group": "openapi",
|
|
"pages": [
|
|
"python-sdk/fastmcp-server-openapi-__init__",
|
|
"python-sdk/fastmcp-server-openapi-components",
|
|
"python-sdk/fastmcp-server-openapi-routing",
|
|
"python-sdk/fastmcp-server-openapi-server"
|
|
]
|
|
},
|
|
{
|
|
"group": "providers",
|
|
"pages": [
|
|
"python-sdk/fastmcp-server-providers-__init__",
|
|
"python-sdk/fastmcp-server-providers-base",
|
|
"python-sdk/fastmcp-server-providers-fastmcp_provider",
|
|
"python-sdk/fastmcp-server-providers-local_provider",
|
|
{
|
|
"group": "openapi",
|
|
"pages": [
|
|
"python-sdk/fastmcp-server-providers-openapi-__init__",
|
|
"python-sdk/fastmcp-server-providers-openapi-components",
|
|
"python-sdk/fastmcp-server-providers-openapi-provider",
|
|
"python-sdk/fastmcp-server-providers-openapi-routing"
|
|
]
|
|
},
|
|
"python-sdk/fastmcp-server-providers-proxy",
|
|
"python-sdk/fastmcp-server-providers-transforming"
|
|
]
|
|
},
|
|
"python-sdk/fastmcp-server-proxy",
|
|
{
|
|
"group": "sampling",
|
|
"pages": [
|
|
"python-sdk/fastmcp-server-sampling-__init__",
|
|
"python-sdk/fastmcp-server-sampling-run",
|
|
"python-sdk/fastmcp-server-sampling-sampling_tool"
|
|
]
|
|
},
|
|
"python-sdk/fastmcp-server-server",
|
|
{
|
|
"group": "tasks",
|
|
"pages": [
|
|
"python-sdk/fastmcp-server-tasks-__init__",
|
|
"python-sdk/fastmcp-server-tasks-capabilities",
|
|
"python-sdk/fastmcp-server-tasks-config",
|
|
"python-sdk/fastmcp-server-tasks-handlers",
|
|
"python-sdk/fastmcp-server-tasks-keys",
|
|
"python-sdk/fastmcp-server-tasks-requests",
|
|
"python-sdk/fastmcp-server-tasks-routing",
|
|
"python-sdk/fastmcp-server-tasks-subscriptions"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "fastmcp.tools",
|
|
"pages": [
|
|
"python-sdk/fastmcp-tools-__init__",
|
|
"python-sdk/fastmcp-tools-tool",
|
|
"python-sdk/fastmcp-tools-tool_transform"
|
|
]
|
|
},
|
|
{
|
|
"group": "fastmcp.utilities",
|
|
"pages": [
|
|
"python-sdk/fastmcp-utilities-__init__",
|
|
"python-sdk/fastmcp-utilities-async_utils",
|
|
"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-lifespan",
|
|
"python-sdk/fastmcp-utilities-logging",
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "openapi",
|
|
"pages": [
|
|
"python-sdk/fastmcp-utilities-openapi-__init__",
|
|
"python-sdk/fastmcp-utilities-openapi-director",
|
|
"python-sdk/fastmcp-utilities-openapi-formatters",
|
|
"python-sdk/fastmcp-utilities-openapi-json_schema_converter",
|
|
"python-sdk/fastmcp-utilities-openapi-models",
|
|
"python-sdk/fastmcp-utilities-openapi-parser",
|
|
"python-sdk/fastmcp-utilities-openapi-schemas"
|
|
]
|
|
},
|
|
"python-sdk/fastmcp-utilities-tests",
|
|
"python-sdk/fastmcp-utilities-types",
|
|
"python-sdk/fastmcp-utilities-ui",
|
|
"python-sdk/fastmcp-utilities-visibility"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"dropdown": "SDK Reference",
|
|
"icon": "code"
|
|
}
|
|
]
|
|
},
|
|
"redirects": [
|
|
{
|
|
"destination": "/servers/providers/proxy",
|
|
"source": "/patterns/proxy"
|
|
},
|
|
{
|
|
"destination": "/servers/providers/mounting",
|
|
"source": "/patterns/composition"
|
|
},
|
|
{
|
|
"destination": "/servers/providers/proxy",
|
|
"source": "/servers/proxy"
|
|
},
|
|
{
|
|
"destination": "/servers/providers/mounting",
|
|
"source": "/servers/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"
|
|
}
|
|
}
|