fastmcp 2.9.1__py3-none-any.whl → 2.10.0__py3-none-any.whl

fastmcp/contrib/component_manager/README.md

@@ -0,0 +1,170 @@
+# Component Manager – Contrib Module for FastMCP
+
+The **Component Manager** provides a unified API for enabling and disabling tools, resources, and prompts at runtime in a FastMCP server. This module is useful for dynamic control over which components are active, enabling advanced features like feature toggling, admin interfaces, or automation workflows.
+
+---
+
+## 🔧 Features
+
+- Enable/disable **tools**, **resources**, and **prompts** via HTTP endpoints.
+- Supports **local** and **mounted (server)** components.
+- Customizable **API root path**.
+- Optional **Auth scopes** for secured access.
+- Fully integrates with FastMCP with minimal configuration.
+
+---
+
+## 📦 Installation
+
+This module is part of the `fastmcp.contrib` package. No separate installation is required if you're already using **FastMCP**.
+
+---
+
+## 🚀 Usage
+
+### Basic Setup
+
+```python
+from fastmcp import FastMCP
+from fastmcp.contrib.component_manager import set_up_component_manager
+
+mcp = FastMCP(name="Component Manager", instructions="This is a test server with component manager.")
+set_up_component_manager(server=mcp)
+```
+
+---
+
+## 🔗 API Endpoints
+
+All endpoints are registered at `/` by default, or under the custom path if one is provided.
+
+### Tools
+
+```http
+POST /tools/{tool_name}/enable
+POST /tools/{tool_name}/disable
+```
+
+### Resources
+
+```http
+POST /resources/{uri:path}/enable
+POST /resources/{uri:path}/disable
+```
+
+ * Supports template URIs as well
+```http
+POST /resources/example://test/{id}/enable
+POST /resources/example://test/{id}/disable
+```
+
+### Prompts
+
+```http
+POST /prompts/{prompt_name}/enable
+POST /prompts/{prompt_name}/disable
+```
+---
+
+#### 🧪 Example Response
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "message": "Disabled tool: example_tool"
+}
+
+```
+
+---
+
+## ⚙️ Configuration Options
+
+### Custom Root Path
+
+To mount the API under a different path:
+
+```python
+set_up_component_manager(server=mcp, path="/admin")
+```
+
+### Securing Endpoints with Auth Scopes
+
+If your server uses authentication:
+
+```python
+mcp = FastMCP(name="Component Manager", instructions="This is a test server with component manager.", auth=auth)
+set_up_component_manager(server=mcp, required_scopes=["write", "read"])
+```
+
+---
+
+## 🧪 Example: Enabling a Tool with Curl
+
+```bash
+curl -X POST \
+  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
+  -H "Content-Type: application/json" \
+  http://localhost:8001/tools/example_tool/enable
+```
+
+---
+
+## 🧱 Working with Mounted Servers
+
+You can also combine different configurations when working with mounted servers — for example, using different scopes:
+
+```python
+mcp = FastMCP(name="Component Manager", instructions="This is a test server with component manager.", auth=auth)
+set_up_component_manager(server=mcp, required_scopes=["mcp:write"])
+
+mounted = FastMCP(name="Component Manager", instructions="This is a test server with component manager.", auth=auth)
+set_up_component_manager(server=mounted, required_scopes=["mounted:write"])
+
+mcp.mount(server=mounted, prefix="mo")
+```
+
+This allows you to grant different levels of access:
+
+```bash
+# Accessing the main server gives you control over both local and mounted components
+curl -X POST \
+  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
+  -H "Content-Type: application/json" \
+  http://localhost:8001/tools/mo_example_tool/enable
+
+# Accessing the mounted server gives you control only over its own components
+curl -X POST \
+  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
+  -H "Content-Type: application/json" \
+  http://localhost:8002/tools/example_tool/enable
+```
+
+---
+
+## ⚙️ How It Works
+
+- `set_up_component_manager()` registers API routes for tools, resources, and prompts.
+- The `ComponentService` class exposes async methods to enable/disable components.
+- Each endpoint returns a success message in JSON or a 404 error if the component isn't found.
+
+---
+
+## 🧩 Extending
+
+You can subclass `ComponentService` for custom behavior or mount its routes elsewhere as needed.
+
+---
+
+## Maintenance Notice
+
+This module is not officially maintained by the core FastMCP team. It is an independent extension developed by [gorocode](https://github.com/gorocode).
+
+If you encounter any issues or wish to contribute, please feel free to open an issue or submit a pull request, and kindly notify me. I'd love to stay up to date.
+
+
+## 📄 License
+
+This module follows the license of the main [FastMCP](https://github.com/jlowin/fastmcp) project.

fastmcp/contrib/component_manager/__init__.py

@@ -0,0 +1,4 @@
+from .component_manager import set_up_component_manager
+from .component_service import ComponentService
+
+__all__ = ["set_up_component_manager", "ComponentService"]

fastmcp/contrib/component_manager/component_manager.py

@@ -0,0 +1,186 @@
+"""
+Routes and helpers for managing tools, resources, and prompts in FastMCP.
+Provides endpoints for enabling/disabling components via HTTP, with optional authentication scopes.
+"""
+
+from typing import Any
+
+from mcp.server.auth.middleware.bearer_auth import RequireAuthMiddleware
+from starlette.applications import Starlette
+from starlette.exceptions import HTTPException as StarletteHTTPException
+from starlette.requests import Request
+from starlette.responses import JSONResponse
+from starlette.routing import Mount, Route
+
+from fastmcp.contrib.component_manager.component_service import ComponentService
+from fastmcp.exceptions import NotFoundError
+from fastmcp.server.server import FastMCP
+
+
+def set_up_component_manager(
+    server: FastMCP, path: str = "/", required_scopes: list[str] | None = None
+):
+    """Set up routes for enabling/disabling tools, resources, and prompts.
+    Args:
+        server: The FastMCP server instance
+        path: Path used to mount all component-related routes on the server
+        required_scopes: Optional list of scopes required for these routes. Applies only if authentication is enabled.
+    """
+
+    service = ComponentService(server)
+    routes: list[Route] = []
+    mounts: list[Mount] = []
+    route_configs = {
+        "tool": {
+            "param": "tool_name",
+            "enable": service._enable_tool,
+            "disable": service._disable_tool,
+        },
+        "resource": {
+            "param": "uri:path",
+            "enable": service._enable_resource,
+            "disable": service._disable_resource,
+        },
+        "prompt": {
+            "param": "prompt_name",
+            "enable": service._enable_prompt,
+            "disable": service._disable_prompt,
+        },
+    }
+
+    if required_scopes is None:
+        routes.extend(build_component_manager_endpoints(route_configs, path))
+    else:
+        if path != "/":
+            mounts.append(
+                build_component_manager_mount(route_configs, path, required_scopes)
+            )
+        else:
+            mounts.append(
+                build_component_manager_mount(
+                    {"tool": route_configs["tool"]}, "/tools", required_scopes
+                )
+            )
+            mounts.append(
+                build_component_manager_mount(
+                    {"resource": route_configs["resource"]},
+                    "/resources",
+                    required_scopes,
+                )
+            )
+            mounts.append(
+                build_component_manager_mount(
+                    {"prompt": route_configs["prompt"]}, "/prompts", required_scopes
+                )
+            )
+
+    server._additional_http_routes.extend(routes)
+    server._additional_http_routes.extend(mounts)
+
+
+def make_endpoint(action, component, config):
+    """
+    Factory for creating Starlette endpoint functions for enabling/disabling a component.
+    Args:
+        action: 'enable' or 'disable'
+        component: The component type (e.g., 'tool', 'resource', or 'prompt')
+        config: Dict with param and handler functions for the component
+    Returns:
+        An async endpoint function for Starlette.
+    """
+
+    async def endpoint(request: Request):
+        name = request.path_params[config["param"].split(":")[0]]
+
+        try:
+            await config[action](name)
+            return JSONResponse(
+                {"message": f"{action.capitalize()}d {component}: {name}"}
+            )
+        except NotFoundError:
+            raise StarletteHTTPException(
+                status_code=404,
+                detail=f"Unknown {component}: {name}",
+            )
+
+    return endpoint
+
+
+def make_route(action, component, config, required_scopes, root_path) -> Route:
+    """
+    Creates a Starlette Route for enabling/disabling a component.
+    Args:
+        action: 'enable' or 'disable'
+        component: The component type
+        config: Dict with param and handler functions
+        required_scopes: Optional list of required auth scopes
+        root_path: The base path for the route
+    Returns:
+        A Starlette Route object.
+    """
+    endpoint = make_endpoint(action, component, config)
+
+    if required_scopes is not None and root_path in [
+        "/tools",
+        "/resources",
+        "/prompts",
+    ]:
+        path = f"/{{{config['param']}}}/{action}"
+    else:
+        if root_path != "/" and required_scopes is None:
+            path = f"{root_path}/{component}s/{{{config['param']}}}/{action}"
+        else:
+            path = f"/{component}s/{{{config['param']}}}/{action}"
+
+    return Route(path, endpoint=endpoint, methods=["POST"])
+
+
+def build_component_manager_endpoints(
+    route_configs, root_path, required_scopes=None
+) -> list[Route]:
+    """
+    Build a list of Starlette Route objects for all components/actions.
+    Args:
+        route_configs: Dict describing component types and their handlers
+        root_path: The base path for the routes
+        required_scopes: Optional list of required auth scopes
+    Returns:
+        List of Starlette Route objects for component management.
+    """
+    component_management_routes: list[Route] = []
+
+    for component in route_configs:
+        config: dict[str, Any] = route_configs[component]
+        for action in ["enable", "disable"]:
+            component_management_routes.append(
+                make_route(action, component, config, required_scopes, root_path)
+            )
+
+    return component_management_routes
+
+
+def build_component_manager_mount(route_configs, root_path, required_scopes) -> Mount:
+    """
+    Build a Starlette Mount with authentication for component management routes.
+    Args:
+        route_configs: Dict describing component types and their handlers
+        root_path: The base path for the mount
+        required_scopes: List of required auth scopes
+    Returns:
+        A Starlette Mount object with authentication middleware.
+    """
+    component_management_routes: list[Route] = []
+
+    for component in route_configs:
+        config: dict[str, Any] = route_configs[component]
+        for action in ["enable", "disable"]:
+            component_management_routes.append(
+                make_route(action, component, config, required_scopes, root_path)
+            )
+
+    return Mount(
+        f"{root_path}",
+        app=RequireAuthMiddleware(
+            Starlette(routes=component_management_routes), required_scopes
+        ),
+    )

fastmcp/contrib/component_manager/component_service.py

@@ -0,0 +1,225 @@
+"""
+ComponentService: Provides async management of tools, resources, and prompts for FastMCP servers.
+Handles enabling/disabling components both locally and across mounted servers.
+"""
+
+from fastmcp.exceptions import NotFoundError
+from fastmcp.prompts.prompt import Prompt
+from fastmcp.resources.resource import Resource
+from fastmcp.resources.template import ResourceTemplate
+from fastmcp.server.server import FastMCP, has_resource_prefix, remove_resource_prefix
+from fastmcp.tools.tool import Tool
+from fastmcp.utilities.logging import get_logger
+
+logger = get_logger(__name__)
+
+
+class ComponentService:
+    """Service for managing components like tools, resources, and prompts."""
+
+    def __init__(self, server: FastMCP):
+        self._server = server
+        self._tool_manager = server._tool_manager
+        self._resource_manager = server._resource_manager
+        self._prompt_manager = server._prompt_manager
+
+    async def _enable_tool(self, key: str) -> Tool:
+        """Handle 'enableTool' requests.
+
+        Args:
+            key: The key of the tool to enable
+
+        Returns:
+            The tool that was enabled
+        """
+        logger.debug("Enabling tool: %s", key)
+
+        # 1. Check local tools first. The server will have already applied its filter.
+        if key in self._server._tool_manager._tools:
+            tool: Tool = await self._server.get_tool(key)
+            tool.enable()
+            return tool
+
+        # 2. Check mounted servers using the filtered protocol path.
+        for mounted in reversed(self._tool_manager._mounted_servers):
+            if mounted.prefix:
+                if key.startswith(f"{mounted.prefix}_"):
+                    tool_key = key.removeprefix(f"{mounted.prefix}_")
+                    mounted_service = ComponentService(mounted.server)
+                    tool = await mounted_service._enable_tool(tool_key)
+                    return tool
+                else:
+                    continue
+        raise NotFoundError(f"Unknown tool: {key}")
+
+    async def _disable_tool(self, key: str) -> Tool:
+        """Handle 'disableTool' requests.
+
+        Args:
+            key: The key of the tool to disable
+
+        Returns:
+            The tool that was disabled
+        """
+        logger.debug("Disable tool: %s", key)
+
+        # 1. Check local tools first. The server will have already applied its filter.
+        if key in self._server._tool_manager._tools:
+            tool: Tool = await self._server.get_tool(key)
+            tool.disable()
+            return tool
+
+        # 2. Check mounted servers using the filtered protocol path.
+        for mounted in reversed(self._tool_manager._mounted_servers):
+            if mounted.prefix:
+                if key.startswith(f"{mounted.prefix}_"):
+                    tool_key = key.removeprefix(f"{mounted.prefix}_")
+                    mounted_service = ComponentService(mounted.server)
+                    tool = await mounted_service._disable_tool(tool_key)
+                    return tool
+                else:
+                    continue
+        raise NotFoundError(f"Unknown tool: {key}")
+
+    async def _enable_resource(self, key: str) -> Resource | ResourceTemplate:
+        """Handle 'enableResource' requests.
+
+        Args:
+            key: The key of the resource to enable
+
+        Returns:
+            The resource that was enabled
+        """
+        logger.debug("Enabling resource: %s", key)
+
+        # 1. Check local resources first. The server will have already applied its filter.
+        if key in self._resource_manager._resources:
+            resource: Resource = await self._server.get_resource(key)
+            resource.enable()
+            return resource
+        if key in self._resource_manager._templates:
+            template: ResourceTemplate = await self._server.get_resource_template(key)
+            template.enable()
+            return template
+
+        # 2. Check mounted servers using the filtered protocol path.
+        for mounted in reversed(self._resource_manager._mounted_servers):
+            if mounted.prefix:
+                if has_resource_prefix(
+                    key,
+                    mounted.prefix,
+                    mounted.resource_prefix_format,
+                ):
+                    key = remove_resource_prefix(
+                        key,
+                        mounted.prefix,
+                        mounted.resource_prefix_format,
+                    )
+                    mounted_service = ComponentService(mounted.server)
+                    mounted_resource: (
+                        Resource | ResourceTemplate
+                    ) = await mounted_service._enable_resource(key)
+                    return mounted_resource
+            else:
+                continue
+        raise NotFoundError(f"Unknown resource: {key}")
+
+    async def _disable_resource(self, key: str) -> Resource | ResourceTemplate:
+        """Handle 'disableResource' requests.
+
+        Args:
+            key: The key of the resource to disable
+
+        Returns:
+            The resource that was disabled
+        """
+        logger.debug("Disable resource: %s", key)
+
+        # 1. Check local resources first. The server will have already applied its filter.
+        if key in self._resource_manager._resources:
+            resource: Resource = await self._server.get_resource(key)
+            resource.disable()
+            return resource
+        if key in self._resource_manager._templates:
+            template: ResourceTemplate = await self._server.get_resource_template(key)
+            template.disable()
+            return template
+
+        # 2. Check mounted servers using the filtered protocol path.
+        for mounted in reversed(self._resource_manager._mounted_servers):
+            if mounted.prefix:
+                if has_resource_prefix(
+                    key,
+                    mounted.prefix,
+                    mounted.resource_prefix_format,
+                ):
+                    key = remove_resource_prefix(
+                        key,
+                        mounted.prefix,
+                        mounted.resource_prefix_format,
+                    )
+                    mounted_service = ComponentService(mounted.server)
+                    mounted_resource: (
+                        Resource | ResourceTemplate
+                    ) = await mounted_service._disable_resource(key)
+                    return mounted_resource
+            else:
+                continue
+        raise NotFoundError(f"Unknown resource: {key}")
+
+    async def _enable_prompt(self, key: str) -> Prompt:
+        """Handle 'enablePrompt' requests.
+
+        Args:
+            key: The key of the prompt to enable
+
+        Returns:
+            The prompt that was enable
+        """
+        logger.debug("Enabling prompt: %s", key)
+
+        # 1. Check local prompts first. The server will have already applied its filter.
+        if key in self._server._prompt_manager._prompts:
+            prompt: Prompt = await self._server.get_prompt(key)
+            prompt.enable()
+            return prompt
+
+        # 2. Check mounted servers using the filtered protocol path.
+        for mounted in reversed(self._prompt_manager._mounted_servers):
+            if mounted.prefix:
+                if key.startswith(f"{mounted.prefix}_"):
+                    prompt_key = key.removeprefix(f"{mounted.prefix}_")
+                    mounted_service = ComponentService(mounted.server)
+                    prompt = await mounted_service._enable_prompt(prompt_key)
+                    return prompt
+                else:
+                    continue
+        raise NotFoundError(f"Unknown prompt: {key}")
+
+    async def _disable_prompt(self, key: str) -> Prompt:
+        """Handle 'disablePrompt' requests.
+
+        Args:
+            key: The key of the prompt to disable
+
+        Returns:
+            The prompt that was disabled
+        """
+
+        # 1. Check local prompts first. The server will have already applied its filter.
+        if key in self._server._prompt_manager._prompts:
+            prompt: Prompt = await self._server.get_prompt(key)
+            prompt.disable()
+            return prompt
+
+        # 2. Check mounted servers using the filtered protocol path.
+        for mounted in reversed(self._prompt_manager._mounted_servers):
+            if mounted.prefix:
+                if key.startswith(f"{mounted.prefix}_"):
+                    prompt_key = key.removeprefix(f"{mounted.prefix}_")
+                    mounted_service = ComponentService(mounted.server)
+                    prompt = await mounted_service._disable_prompt(prompt_key)
+                    return prompt
+                else:
+                    continue
+        raise NotFoundError(f"Unknown prompt: {key}")

fastmcp/contrib/component_manager/example.py

@@ -0,0 +1,59 @@
+from fastmcp import FastMCP
+from fastmcp.contrib.component_manager import set_up_component_manager
+from fastmcp.server.auth.providers.bearer import BearerAuthProvider, RSAKeyPair
+
+key_pair = RSAKeyPair.generate()
+
+auth = BearerAuthProvider(
+    public_key=key_pair.public_key,
+    issuer="https://dev.example.com",
+    audience="my-dev-server",
+    required_scopes=["mcp:read"],
+)
+
+# Build main server
+mcp_token = key_pair.create_token(
+    subject="dev-user",
+    issuer="https://dev.example.com",
+    audience="my-dev-server",
+    scopes=["mcp:write", "mcp:read"],
+)
+mcp = FastMCP(
+    name="Component Manager",
+    instructions="This is a test server with component manager.",
+    auth=auth,
+)
+
+# Set up main server component manager
+set_up_component_manager(server=mcp, required_scopes=["mcp:write"])
+
+# Build mounted server
+mounted_token = key_pair.create_token(
+    subject="dev-user",
+    issuer="https://dev.example.com",
+    audience="my-dev-server",
+    scopes=["mounted:write", "mcp:read"],
+)
+mounted = FastMCP(
+    name="Component Manager",
+    instructions="This is a test server with component manager.",
+    auth=auth,
+)
+
+# Set up mounted server component manager
+set_up_component_manager(server=mounted, required_scopes=["mounted:write"])
+
+# Mount
+mcp.mount(server=mounted, prefix="mo")
+
+
+@mcp.resource("resource://greeting")
+def get_greeting() -> str:
+    """Provides a simple greeting message."""
+    return "Hello from FastMCP Resources!"
+
+
+@mounted.tool("greeting")
+def get_info() -> str:
+    """Provides a simple info."""
+    return "You are using component manager contrib module!"