Spaces:
Running
Running
| { | |
| "$schema": "https://mintlify.com/docs.json", | |
| "appearance": { | |
| "default": "system", | |
| "strict": false | |
| }, | |
| "background": { | |
| "color": { | |
| "dark": "#222831", | |
| "light": "#EEEEEE" | |
| }, | |
| "decoration": "windows" | |
| }, | |
| "banner": { | |
| "content": "FastMCP Cloud is here! [Join the beta](https://fastmcp.link/x0Kyhy2)." | |
| }, | |
| "colors": { | |
| "dark": "#f72585", | |
| "light": "#4cc9f0", | |
| "primary": "#2d00f7" | |
| }, | |
| "description": "The fast, Pythonic way to build MCP servers and clients.", | |
| "favicon": { | |
| "dark": "/assets/favicon.svg", | |
| "light": "/assets/favicon.svg" | |
| }, | |
| "footer": { | |
| "socials": { | |
| "bluesky": "https://bsky.app/profile/jlowin.dev", | |
| "github": "https://github.com/jlowin/fastmcp", | |
| "x": "https://x.com/jlowin" | |
| } | |
| }, | |
| "integrations": { | |
| "ga4": { | |
| "measurementId": "G-64R5W1TJXG" | |
| } | |
| }, | |
| "name": "FastMCP", | |
| "navbar": { | |
| "primary": { | |
| "href": "https://github.com/jlowin/fastmcp", | |
| "type": "github" | |
| } | |
| }, | |
| "navigation": { | |
| "tabs": [ | |
| { | |
| "tab": "Documentation", | |
| "anchors": [ | |
| { | |
| "anchor": "Documentation", | |
| "groups": [ | |
| { | |
| "group": "Get Started", | |
| "pages": [ | |
| "getting-started/welcome", | |
| "getting-started/installation", | |
| "getting-started/quickstart" | |
| ] | |
| }, | |
| { | |
| "group": "Servers", | |
| "pages": [ | |
| { | |
| "group": "Essentials", | |
| "icon": "cube", | |
| "pages": ["servers/server", "deployment/running-server"] | |
| }, | |
| { | |
| "group": "Core Components", | |
| "icon": "toolbox", | |
| "pages": [ | |
| "servers/tools", | |
| "servers/resources", | |
| "servers/prompts" | |
| ] | |
| }, | |
| { | |
| "group": "Advanced Features", | |
| "icon": "stars", | |
| "pages": [ | |
| "servers/context", | |
| "servers/proxy", | |
| "servers/composition", | |
| "servers/elicitation", | |
| "servers/logging", | |
| "servers/progress", | |
| "servers/sampling", | |
| "servers/middleware" | |
| ] | |
| }, | |
| { | |
| "group": "Authentication", | |
| "icon": "shield-check", | |
| "pages": ["servers/auth/verifiers"] | |
| } | |
| ] | |
| }, | |
| { | |
| "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": [ | |
| "integrations/anthropic", | |
| "integrations/chatgpt", | |
| "integrations/claude-code", | |
| "integrations/claude-desktop", | |
| "integrations/cursor", | |
| "integrations/eunomia-authorization", | |
| "integrations/fastapi", | |
| "integrations/gemini", | |
| "integrations/mcp-json-configuration", | |
| "integrations/openai", | |
| "integrations/openapi", | |
| "integrations/permit", | |
| "integrations/starlette" | |
| ] | |
| }, | |
| { | |
| "group": "Patterns", | |
| "pages": [ | |
| "patterns/tool-transformation", | |
| "patterns/decorating-methods", | |
| "patterns/http-requests", | |
| "patterns/testing", | |
| "patterns/cli", | |
| "patterns/contrib" | |
| ] | |
| }, | |
| { | |
| "group": "Tutorials", | |
| "pages": [ | |
| "tutorials/mcp", | |
| "tutorials/create-mcp-server", | |
| "tutorials/rest-api" | |
| ] | |
| } | |
| ], | |
| "icon": "book" | |
| }, | |
| { | |
| "anchor": "What's New", | |
| "pages": ["updates", "changelog"] | |
| }, | |
| { | |
| "anchor": "Community", | |
| "icon": "users", | |
| "pages": ["community/showcase"] | |
| } | |
| ] | |
| }, | |
| { | |
| "tab": "SDK Reference", | |
| "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-claude", | |
| "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-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", | |
| { | |
| "group": "providers", | |
| "pages": [ | |
| "python-sdk/fastmcp-server-auth-providers-__init__", | |
| "python-sdk/fastmcp-server-auth-providers-bearer", | |
| "python-sdk/fastmcp-server-auth-providers-bearer_env", | |
| "python-sdk/fastmcp-server-auth-providers-in_memory" | |
| ] | |
| } | |
| ] | |
| }, | |
| "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-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-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-cache", | |
| "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", | |
| "python-sdk/fastmcp-utilities-openapi", | |
| "python-sdk/fastmcp-utilities-tests", | |
| "python-sdk/fastmcp-utilities-types" | |
| ] | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| "redirects": [ | |
| { | |
| "destination": "/servers/proxy", | |
| "source": "/patterns/proxy" | |
| }, | |
| { | |
| "destination": "/servers/composition", | |
| "source": "/patterns/composition" | |
| } | |
| ], | |
| "search": { | |
| "prompt": "Search the docs..." | |
| }, | |
| "theme": "mint" | |
| } | |