instruction stringclasses 100
values | code stringlengths 78 193k | response stringlengths 259 170k | file stringlengths 59 203 |
|---|---|---|---|
Generate docstrings for this script | import contextlib
import datetime
from collections.abc import AsyncIterator
from typing import Any
from mcp import ClientSession
from typing_extensions import Unpack
from fastmcp.client.transports.base import ClientTransport, SessionKwargs
from fastmcp.client.transports.memory import FastMCPTransport
from fastmcp.mcp... | --- +++ @@ -20,6 +20,51 @@
class MCPConfigTransport(ClientTransport):
+ """Transport for connecting to one or more MCP servers defined in an MCPConfig.
+
+ This transport provides a unified interface to multiple MCP servers defined in an MCPConfig
+ object or dictionary matching the MCPConfig schema. It su... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/client/transports/config.py |
Document all public functions with docstrings |
from __future__ import annotations
import datetime
import re
from pathlib import Path
from typing import TYPE_CHECKING, Annotated, Any, Literal, cast
from urllib.parse import urlparse
import httpx
from pydantic import (
AnyUrl,
BaseModel,
ConfigDict,
Field,
model_validator,
)
from typing_extensio... | --- +++ @@ -1,3 +1,26 @@+"""Canonical MCP Configuration Format.
+
+This module defines the standard configuration format for Model Context Protocol (MCP) servers.
+It provides a client-agnostic, extensible format that can be used across all MCP implementations.
+
+The configuration format supports both stdio and remote... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/mcp_config.py |
Write docstrings for algorithm functions |
from __future__ import annotations
import fnmatch
import json
import time
from collections.abc import Mapping
from dataclasses import dataclass
from datetime import timezone
from email.utils import parsedate_to_datetime
from typing import TYPE_CHECKING, Any, Literal
from urllib.parse import urlparse
from pydantic im... | --- +++ @@ -1,3 +1,18 @@+"""CIMD (Client ID Metadata Document) support for FastMCP.
+
+.. warning::
+ **Beta Feature**: CIMD support is currently in beta. The API may change
+ in future releases. Please report any issues you encounter.
+
+CIMD is a simpler alternative to Dynamic Client Registration where clients
... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/cimd.py |
Write docstrings for algorithm functions |
from __future__ import annotations
import inspect
import uuid
from collections.abc import AsyncIterator, Callable, Sequence
from contextlib import asynccontextmanager, suppress
from typing import Any, Literal, TypeVar, overload
from mcp.types import AnyFunction, Icon, ToolAnnotations
from fastmcp.decorators import ... | --- +++ @@ -1,3 +1,28 @@+"""FastMCPApp — a Provider that represents a composable MCP application.
+
+FastMCPApp binds entry-point tools (model calls these) together with backend
+tools (the UI calls these via CallTool). Backend tools get global keys —
+UUID-suffixed stable identifiers that survive namespace transforms ... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/app.py |
Add docstrings that explain purpose and usage |
from mcp.server.auth.middleware.bearer_auth import RequireAuthMiddleware
from starlette.applications import Starlette
from starlette.requests import Request
from starlette.responses import JSONResponse
from starlette.routing import Mount, Route
from fastmcp.server.server import FastMCP
def set_up_component_manager(... | --- +++ @@ -1,3 +1,9 @@+"""
+HTTP routes for enabling/disabling components in FastMCP.
+
+Provides REST endpoints for controlling component enabled state with optional
+authentication scopes.
+"""
from mcp.server.auth.middleware.bearer_auth import RequireAuthMiddleware
from starlette.applications import Starlette
@... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/contrib/component_manager/component_manager.py |
Add missing documentation to my Python functions |
from __future__ import annotations
import uuid
import weakref
from typing import TYPE_CHECKING, Any, Literal, overload
import mcp.types
from pydantic import AnyUrl, RootModel
if TYPE_CHECKING:
from fastmcp.client.client import Client
from fastmcp.client.tasks import ResourceTask
from fastmcp.client.telemetry i... | --- +++ @@ -1,3 +1,4 @@+"""Resource-related methods for FastMCP Client."""
from __future__ import annotations
@@ -27,12 +28,26 @@
class ClientResourcesMixin:
+ """Mixin providing resource-related methods for Client."""
# --- Resources ---
async def list_resources_mcp(
self: Client, *,... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/client/mixins/resources.py |
Create docstrings for all classes and functions |
from __future__ import annotations
import hashlib
import secrets
import time
from base64 import urlsafe_b64encode
from typing import Any, Literal
from urllib.parse import urlencode, urlparse, urlunparse
import httpx
from authlib.common.security import generate_token
from authlib.integrations.httpx_client import Asyn... | --- +++ @@ -1,3 +1,20 @@+"""OAuth Proxy Provider for FastMCP.
+
+This provider acts as a transparent proxy to an upstream OAuth Authorization Server,
+handling Dynamic Client Registration locally while forwarding all other OAuth flows.
+This enables authentication with upstream providers that don't support DCR or have
... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/oauth_proxy/proxy.py |
Add docstrings to my Python code |
import os
import sys
from pathlib import Path
from typing import Annotated
import cyclopts
from rich import print
from fastmcp.mcp_config import StdioMCPServer, update_config_file
from fastmcp.utilities.logging import get_logger
from fastmcp.utilities.mcp_server_config.v1.environments.uv import UVEnvironment
from .... | --- +++ @@ -1,3 +1,4 @@+"""Claude Desktop integration for FastMCP install using Cyclopts."""
import os
import sys
@@ -17,6 +18,11 @@
def get_claude_config_path(config_path: Path | None = None) -> Path | None:
+ """Get the Claude config directory based on platform.
+
+ Args:
+ config_path: Optional ... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/cli/install/claude_desktop.py |
Add docstrings to improve code quality |
import asyncio
import contextlib
import json
import os
import re
import signal
import subprocess
import sys
from collections.abc import Callable
from pathlib import Path
from typing import Any, Literal
from mcp.server.fastmcp import FastMCP as FastMCP1x
from watchfiles import Change, awatch
from fastmcp.server.serve... | --- +++ @@ -1,3 +1,4 @@+"""FastMCP run command implementation with enhanced type hints."""
import asyncio
import contextlib
@@ -80,11 +81,20 @@
def is_url(path: str) -> bool:
+ """Check if a string is a URL."""
url_pattern = re.compile(r"^https?://")
return bool(url_pattern.match(path))
def cr... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/cli/run.py |
Add docstrings that explain purpose and usage |
from __future__ import annotations
import abc
import asyncio
import inspect
import time
import weakref
from collections.abc import Awaitable, Callable
from datetime import datetime, timezone
from typing import TYPE_CHECKING, Generic, TypeVar
import mcp.types
from mcp.types import GetTaskResult, TaskStatusNotificatio... | --- +++ @@ -1,3 +1,4 @@+"""SEP-1686 client Task classes."""
from __future__ import annotations
@@ -23,12 +24,14 @@
class TaskNotificationHandler(MessageHandler):
+ """MessageHandler that routes task status notifications to Task objects."""
def __init__(self, client: Client):
super().__init__... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/client/tasks.py |
Add docstrings to improve code quality |
from typing import Literal
from key_value.aio.protocols import AsyncKeyValue
from pydantic import AnyHttpUrl
from fastmcp.server.auth.oidc_proxy import OIDCProxy
from fastmcp.utilities.auth import parse_scopes
from fastmcp.utilities.logging import get_logger
logger = get_logger(__name__)
class Auth0Provider(OIDCP... | --- +++ @@ -1,3 +1,25 @@+"""Auth0 OAuth provider for FastMCP.
+
+This module provides a complete Auth0 integration that's ready to use with
+just the configuration URL, client ID, client secret, audience, and base URL.
+
+Example:
+ ```python
+ from fastmcp import FastMCP
+ from fastmcp.server.auth.providers.a... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/providers/auth0.py |
Write docstrings including parameters and return values |
from __future__ import annotations
import base64
import time
from typing import Any, overload
from authlib.jose import JsonWebToken
from authlib.jose.errors import JoseError
from cryptography.hazmat.primitives import hashes
from cryptography.hazmat.primitives.kdf.hkdf import HKDF
from cryptography.hazmat.primitives.... | --- +++ @@ -1,3 +1,9 @@+"""JWT token issuance and verification for FastMCP OAuth Proxy.
+
+This module implements the token factory pattern for OAuth proxies, where the proxy
+issues its own JWT tokens to clients instead of forwarding upstream provider tokens.
+This maintains proper OAuth 2.0 token audience boundaries.... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/jwt_issuer.py |
Document functions with detailed explanations |
import base64
import sys
from pathlib import Path
from typing import Annotated
from urllib.parse import quote
import cyclopts
from rich import print
from fastmcp.mcp_config import StdioMCPServer, update_config_file
from fastmcp.utilities.logging import get_logger
from fastmcp.utilities.mcp_server_config.v1.environme... | --- +++ @@ -1,3 +1,4 @@+"""Cursor integration for FastMCP install using Cyclopts."""
import base64
import sys
@@ -22,6 +23,15 @@ server_name: str,
server_config: StdioMCPServer,
) -> str:
+ """Generate a Cursor deeplink for installing the MCP server.
+
+ Args:
+ server_name: Name of the serve... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/cli/install/cursor.py |
Generate docstrings for this script |
from __future__ import annotations
from uuid import uuid4
from key_value.aio.adapters.pydantic import PydanticAdapter
from key_value.aio.protocols import AsyncKeyValue
from key_value.aio.stores.memory import MemoryStore
from mcp.server.streamable_http import EventCallback, EventId, EventMessage, StreamId
from mcp.se... | --- +++ @@ -1,3 +1,10 @@+"""EventStore implementation backed by AsyncKeyValue.
+
+This module provides an EventStore implementation that enables SSE polling/resumability
+for Streamable HTTP transports. Events are stored using the key_value package's
+AsyncKeyValue protocol, allowing users to configure any compatible b... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/event_store.py |
Can you add docstrings to this Python file? |
from __future__ import annotations
from typing import Literal
from key_value.aio.protocols import AsyncKeyValue
from pydantic import AnyHttpUrl
from fastmcp.server.auth.auth import AccessToken
from fastmcp.server.auth.oidc_proxy import OIDCProxy
from fastmcp.server.auth.providers.jwt import JWTVerifier
from fastmcp... | --- +++ @@ -1,3 +1,25 @@+"""AWS Cognito OAuth provider for FastMCP.
+
+This module provides a complete AWS Cognito OAuth integration that's ready to use
+with a user pool ID, domain prefix, client ID and client secret. It handles all
+the complexity of AWS Cognito's OAuth flow, token validation, and user management.
+
... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/providers/aws.py |
Create docstrings for each class method | from __future__ import annotations
import weakref
from collections.abc import Awaitable, Callable
from contextlib import AsyncExitStack
from typing import TYPE_CHECKING, Any
import anyio
import mcp.types
from anyio.streams.memory import MemoryObjectReceiveStream, MemoryObjectSendStream
from mcp import LoggingLevel, M... | --- +++ @@ -34,6 +34,7 @@
class MiddlewareServerSession(ServerSession):
+ """ServerSession that routes initialization requests through FastMCP middleware."""
def __init__(self, fastmcp: FastMCP, *args, **kwargs):
super().__init__(*args, **kwargs)
@@ -45,12 +46,18 @@
@property
def fastm... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/low_level.py |
Create docstrings for API functions |
import asyncio
import logging
import traceback
from collections.abc import Callable
from typing import Any
import anyio
from mcp import McpError
from mcp.types import ErrorData
from fastmcp.exceptions import NotFoundError
from .middleware import CallNext, Middleware, MiddlewareContext
class ErrorHandlingMiddlewar... | --- +++ @@ -1,3 +1,4 @@+"""Error handling middleware for consistent error responses and tracking."""
import asyncio
import logging
@@ -15,6 +16,23 @@
class ErrorHandlingMiddleware(Middleware):
+ """Middleware that provides consistent error handling and logging.
+
+ Catches exceptions, logs them appropriat... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/middleware/error_handling.py |
Generate consistent documentation across files |
from __future__ import annotations
import logging
from collections.abc import Sequence
import mcp.types as mt
from fastmcp.exceptions import AuthorizationError
from fastmcp.prompts.base import Prompt, PromptResult
from fastmcp.resources.base import Resource, ResourceResult
from fastmcp.resources.template import Res... | --- +++ @@ -1,3 +1,25 @@+"""Authorization middleware for FastMCP.
+
+This module provides middleware-based authorization using callable auth checks.
+AuthMiddleware applies auth checks globally to all components on the server.
+
+Example:
+ ```python
+ from fastmcp import FastMCP
+ from fastmcp.server.auth imp... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/middleware/authorization.py |
Generate docstrings for this script | from __future__ import annotations
from collections.abc import AsyncGenerator, Callable, Generator
from contextlib import asynccontextmanager, contextmanager
from contextvars import ContextVar
from typing import TYPE_CHECKING
from mcp.server.auth.routes import build_resource_metadata_url
from mcp.server.lowlevel.serv... | --- +++ @@ -30,6 +30,7 @@
class StreamableHTTPASGIApp:
+ """ASGI application wrapper for Streamable HTTP server transport."""
def __init__(self, session_manager):
self.session_manager = session_manager
@@ -82,6 +83,9 @@
class RequestContextMiddleware:
+ """
+ Middleware that stores each... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/http.py |
Document classes and their methods |
import hashlib
from collections.abc import Sequence
from logging import Logger
from typing import Any, TypedDict
import mcp.types
import pydantic_core
from key_value.aio.adapters.pydantic import PydanticAdapter
from key_value.aio.protocols.key_value import AsyncKeyValue
from key_value.aio.stores.memory import MemoryS... | --- +++ @@ -1,3 +1,4 @@+"""A middleware for response caching."""
import hashlib
from collections.abc import Sequence
@@ -36,6 +37,7 @@
class CachableResourceContent(FastMCPBaseModel):
+ """A wrapper for ResourceContent that can be cached."""
content: str | bytes
mime_type: str | None = None
@@ -4... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/middleware/caching.py |
Generate missing documentation strings |
from __future__ import annotations
import contextlib
import time
from datetime import datetime
from typing import Literal
import httpx
from key_value.aio.protocols import AsyncKeyValue
from pydantic import AnyHttpUrl
from fastmcp.server.auth import TokenVerifier
from fastmcp.server.auth.auth import AccessToken
from... | --- +++ @@ -1,3 +1,23 @@+"""Discord OAuth provider for FastMCP.
+
+This module provides a complete Discord OAuth integration that's ready to use
+with just a client ID and client secret. It handles all the complexity of
+Discord's OAuth flow, token validation, and user management.
+
+Example:
+ ```python
+ from f... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/providers/discord.py |
Document this code for team use |
from __future__ import annotations
import hashlib
from collections import OrderedDict
from typing import TYPE_CHECKING, Any, Literal, cast
import httpx
from key_value.aio.protocols import AsyncKeyValue
from fastmcp.dependencies import Dependency
from fastmcp.server.auth.oauth_proxy import OAuthProxy
from fastmcp.se... | --- +++ @@ -1,3 +1,8 @@+"""Azure (Microsoft Entra) OAuth provider for FastMCP.
+
+This provider implements Azure/Microsoft Entra ID OAuth authentication
+using the OAuth Proxy pattern for non-DCR OAuth flows.
+"""
from __future__ import annotations
@@ -28,6 +33,64 @@
class AzureProvider(OAuthProxy):
+ """Az... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/providers/azure.py |
Add docstrings to existing functions |
from __future__ import annotations
import contextlib
import json
import time
from dataclasses import dataclass
from typing import Any, cast
import httpx
from authlib.jose import JsonWebKey, JsonWebToken
from authlib.jose.errors import JoseError
from cryptography.hazmat.primitives import serialization
from cryptograp... | --- +++ @@ -1,3 +1,4 @@+"""TokenVerifier implementations for FastMCP."""
from __future__ import annotations
@@ -24,6 +25,7 @@
class JWKData(TypedDict, total=False):
+ """JSON Web Key data structure."""
kty: str # Key type (e.g., "RSA") - required
kid: str # Key ID (optional but recommended)
@@... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/providers/jwt.py |
Add docstrings including usage examples |
import warnings
from collections.abc import Sequence
from logging import Logger
from typing import Annotated, Any
import mcp.types
from mcp.types import Prompt
from pydantic import AnyUrl
from typing_extensions import override
import fastmcp
from fastmcp.resources.base import ResourceResult
from fastmcp.server.conte... | --- +++ @@ -1,3 +1,4 @@+"""A middleware for injecting tools into the MCP server context."""
import warnings
from collections.abc import Sequence
@@ -20,8 +21,10 @@
class ToolInjectionMiddleware(Middleware):
+ """A middleware for injecting tools into the context."""
def __init__(self, tools: Sequence[T... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/middleware/tool_injection.py |
Generate documentation strings for clarity |
from __future__ import annotations
import inspect
from collections.abc import Awaitable, Callable
from fastmcp.server.auth import TokenVerifier
from fastmcp.server.auth.auth import AccessToken
from fastmcp.utilities.logging import get_logger
logger = get_logger(__name__)
class DebugTokenVerifier(TokenVerifier):
... | --- +++ @@ -1,3 +1,29 @@+"""Debug token verifier for testing and special cases.
+
+This module provides a flexible token verifier that delegates validation
+to a custom callable. Useful for testing, development, or scenarios where
+standard verification isn't possible (like opaque tokens without introspection).
+
+Exam... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/providers/debug.py |
Add standardized docstrings across the file |
from collections.abc import Sequence
from typing import Any
import mcp.types as mt
from typing_extensions import override
from fastmcp.resources.template import ResourceTemplate
from fastmcp.server.middleware.middleware import CallNext, Middleware, MiddlewareContext
from fastmcp.tools.base import Tool
from fastmcp.u... | --- +++ @@ -1,3 +1,4 @@+"""Middleware that dereferences $ref in JSON schemas before sending to clients."""
from collections.abc import Sequence
from typing import Any
@@ -12,6 +13,12 @@
class DereferenceRefsMiddleware(Middleware):
+ """Dereferences $ref in component schemas before sending to clients.
+
+ ... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/middleware/dereference.py |
Replace inline comments with docstrings |
from __future__ import annotations
from urllib.parse import urlparse
import httpx
from pydantic import AnyHttpUrl
from starlette.responses import JSONResponse
from starlette.routing import Route
from fastmcp.server.auth import RemoteAuthProvider, TokenVerifier
from fastmcp.server.auth.providers.jwt import JWTVerifi... | --- +++ @@ -1,3 +1,9 @@+"""Descope authentication provider for FastMCP.
+
+This module provides DescopeProvider - a complete authentication solution that integrates
+with Descope's OAuth 2.1 and OpenID Connect services, supporting Dynamic Client Registration (DCR)
+for seamless MCP client authentication.
+"""
from _... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/providers/descope.py |
Improve documentation using docstrings |
from __future__ import annotations
import logging
import mcp.types as mt
import pydantic_core
from mcp.types import TextContent
from fastmcp.tools.base import ToolResult
from .middleware import CallNext, Middleware, MiddlewareContext
__all__ = ["ResponseLimitingMiddleware"]
logger = logging.getLogger(__name__)
... | --- +++ @@ -1,3 +1,4 @@+"""Response limiting middleware for controlling tool response sizes."""
from __future__ import annotations
@@ -17,6 +18,33 @@
class ResponseLimitingMiddleware(Middleware):
+ """Middleware that limits the response size of tool calls.
+
+ Intercepts tool call responses and enforces ... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/middleware/response_limiting.py |
Generate documentation strings for clarity |
import logging
import time
from typing import Any
from .middleware import CallNext, Middleware, MiddlewareContext
class TimingMiddleware(Middleware):
def __init__(
self, logger: logging.Logger | None = None, log_level: int = logging.INFO
):
self.logger = logger or logging.getLogger("fastmcp... | --- +++ @@ -1,3 +1,4 @@+"""Timing middleware for measuring and logging request performance."""
import logging
import time
@@ -7,14 +8,36 @@
class TimingMiddleware(Middleware):
+ """Middleware that logs the execution time of requests.
+
+ Only measures and logs timing for request messages (not notification... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/middleware/timing.py |
Add docstrings for production code |
from __future__ import annotations
from collections.abc import Awaitable, Callable
from functools import partial
from typing import TYPE_CHECKING, Any, Literal
import anyio
import uvicorn
from mcp.server.lowlevel.server import NotificationOptions
from mcp.server.stdio import stdio_server
from starlette.middleware im... | --- +++ @@ -1,3 +1,4 @@+"""Transport-related methods for FastMCP Server."""
from __future__ import annotations
@@ -34,6 +35,10 @@
class TransportMixin:
+ """Mixin providing transport-related methods for FastMCP.
+
+ Includes HTTP/stdio/SSE transport handling and custom HTTP routes.
+ """
async ... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/mixins/transport.py |
Generate NumPy-style docstrings |
from __future__ import annotations
import enum
import re
from collections.abc import Callable
from dataclasses import dataclass, field
from re import Pattern
from typing import TYPE_CHECKING, Literal
if TYPE_CHECKING:
from fastmcp.server.providers.openapi.components import (
OpenAPIResource,
Open... | --- +++ @@ -1,3 +1,4 @@+"""Route mapping logic for OpenAPI operations."""
from __future__ import annotations
@@ -39,6 +40,14 @@
class MCPType(enum.Enum):
+ """Type of FastMCP component to create from a route.
+
+ Enum values:
+ TOOL: Convert the route to a callable Tool
+ RESOURCE: Convert ... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/openapi/routing.py |
Expand my code with proper documentation strings |
from __future__ import annotations
import asyncio
from collections.abc import Sequence
from pathlib import Path
from fastmcp.prompts.base import Prompt
from fastmcp.resources.base import Resource
from fastmcp.resources.template import ResourceTemplate
from fastmcp.server.providers.filesystem_discovery import discove... | --- +++ @@ -1,3 +1,29 @@+"""FileSystemProvider for filesystem-based component discovery.
+
+FileSystemProvider scans a directory for Python files, imports them, and
+registers any Tool, Resource, ResourceTemplate, or Prompt objects found.
+
+Components are created using the standalone decorators from fastmcp.tools,
+fa... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/filesystem.py |
Document this module using docstrings |
from __future__ import annotations
import contextlib
from typing import Literal
import httpx
from key_value.aio.protocols import AsyncKeyValue
from pydantic import AnyHttpUrl
from starlette.responses import JSONResponse
from starlette.routing import Route
from fastmcp.server.auth import AccessToken, RemoteAuthProvi... | --- +++ @@ -1,3 +1,12 @@+"""WorkOS authentication providers for FastMCP.
+
+This module provides two WorkOS authentication strategies:
+
+1. WorkOSProvider - OAuth proxy for WorkOS Connect applications (non-DCR)
+2. AuthKitProvider - DCR-compliant provider for WorkOS AuthKit
+
+Choose based on your WorkOS setup and aut... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/providers/workos.py |
Generate consistent docstrings |
from __future__ import annotations
import inspect
from collections.abc import Callable
from typing import TYPE_CHECKING, Any, TypeVar
import mcp.types
from mcp.types import Annotations, AnyFunction
import fastmcp
from fastmcp.resources.base import Resource
from fastmcp.resources.function_resource import resource as... | --- +++ @@ -1,3 +1,8 @@+"""Resource decorator mixin for LocalProvider.
+
+This module provides the ResourceDecoratorMixin class that adds resource
+and template registration functionality to LocalProvider.
+"""
from __future__ import annotations
@@ -22,10 +27,21 @@
class ResourceDecoratorMixin:
+ """Mixin c... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/local_provider/decorators/resources.py |
Create structured documentation for my script |
from typing import Any
import anyio
from .middleware import CallNext, Middleware, MiddlewareContext
class PingMiddleware(Middleware):
def __init__(self, interval_ms: int = 30000):
if interval_ms <= 0:
raise ValueError("interval_ms must be positive")
self.interval_ms = interval_ms
... | --- +++ @@ -1,3 +1,4 @@+"""Ping middleware for keeping client connections alive."""
from typing import Any
@@ -7,8 +8,31 @@
class PingMiddleware(Middleware):
+ """Middleware that sends periodic pings to keep client connections alive.
+
+ Starts a background ping task on first message from each session. T... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/middleware/ping.py |
Add missing documentation to my Python functions |
from __future__ import annotations
import re
from collections.abc import AsyncIterator, Sequence
from contextlib import asynccontextmanager
from typing import TYPE_CHECKING, Any, overload
from urllib.parse import quote
import mcp.types
from mcp.types import AnyUrl
from fastmcp.prompts.base import Prompt, PromptResu... | --- +++ @@ -1,3 +1,12 @@+"""FastMCPProvider for wrapping FastMCP servers as providers.
+
+This module provides the `FastMCPProvider` class that wraps a FastMCP server
+and exposes its components through the Provider interface.
+
+It also provides FastMCPProvider* component classes that delegate execution to
+the wrappe... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/fastmcp_provider.py |
Document this module using docstrings |
from __future__ import annotations
import base64
import contextlib
import hashlib
import time
from dataclasses import dataclass
from typing import Any, Literal, get_args
import httpx
from pydantic import AnyHttpUrl, SecretStr
from fastmcp.server.auth import AccessToken, TokenVerifier
from fastmcp.utilities.auth imp... | --- +++ @@ -1,3 +1,25 @@+"""OAuth 2.0 Token Introspection (RFC 7662) provider for FastMCP.
+
+This module provides token verification for opaque tokens using the OAuth 2.0
+Token Introspection protocol defined in RFC 7662. It allows FastMCP servers to
+validate tokens issued by authorization servers that don't use JWT ... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/providers/introspection.py |
Turn comments into proper docstrings |
from typing import Literal
from key_value.aio.protocols import AsyncKeyValue
from pydantic import AnyHttpUrl
from fastmcp.server.auth.oidc_proxy import OIDCProxy
from fastmcp.utilities.auth import parse_scopes
from fastmcp.utilities.logging import get_logger
logger = get_logger(__name__)
class OCIProvider(OIDCPro... | --- +++ @@ -1,3 +1,81 @@+"""OCI OIDC provider for FastMCP.
+
+The pull request for the provider is submitted to fastmcp.
+
+This module provides OIDC Implementation to integrate MCP servers with OCI.
+You only need OCI Identity Domain's discovery URL, client ID, client secret, and base URL.
+
+Post Authentication, you ... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/providers/oci.py |
Write docstrings for utility functions | from __future__ import annotations
import logging
import weakref
from collections.abc import Callable, Generator, Mapping, Sequence
from contextlib import contextmanager
from contextvars import ContextVar, Token
from dataclasses import dataclass
from logging import Logger
from typing import Any, Literal, overload
imp... | --- +++ @@ -88,15 +88,22 @@ def set_transport(
transport: TransportType,
) -> Token[TransportType | None]:
+ """Set the current transport type. Returns token for reset."""
return _current_transport.set(transport)
def reset_transport(token: Token[TransportType | None]) -> None:
+ """Reset transport... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/context.py |
Create documentation strings for testing functions |
from __future__ import annotations
import inspect
from collections.abc import Callable
from functools import partial
from typing import TYPE_CHECKING, Any, TypeVar, overload
import mcp.types
from mcp.types import AnyFunction
import fastmcp
from fastmcp.prompts.base import Prompt
from fastmcp.prompts.function_prompt... | --- +++ @@ -1,3 +1,8 @@+"""Prompt decorator mixin for LocalProvider.
+
+This module provides the PromptDecoratorMixin class that adds prompt
+registration functionality to LocalProvider.
+"""
from __future__ import annotations
@@ -22,8 +27,18 @@
class PromptDecoratorMixin:
+ """Mixin class providing prompt ... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/local_provider/decorators/prompts.py |
Generate descriptive docstrings automatically |
import fnmatch
from urllib.parse import urlparse
from pydantic import AnyUrl
def _parse_host_port(netloc: str) -> tuple[str | None, str | None]:
# Handle userinfo (remove it for parsing, but we check separately)
if "@" in netloc:
netloc = netloc.split("@")[-1]
# Handle IPv6 addresses [::1]:port... | --- +++ @@ -1,3 +1,8 @@+"""Utilities for validating client redirect URIs in OAuth flows.
+
+This module provides secure redirect URI validation with wildcard support,
+protecting against userinfo-based bypass attacks like http://localhost@evil.com.
+"""
import fnmatch
from urllib.parse import urlparse
@@ -6,6 +11,1... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/redirect_validation.py |
Write documentation strings for class attributes |
from __future__ import annotations
from collections import Counter
from collections.abc import AsyncIterator, Sequence
from contextlib import asynccontextmanager
from typing import Any, Literal, cast
import httpx
from jsonschema_path import SchemaPath
from fastmcp.prompts import Prompt
from fastmcp.resources import... | --- +++ @@ -1,3 +1,4 @@+"""OpenAPIProvider for creating MCP components from OpenAPI specifications."""
from __future__ import annotations
@@ -48,6 +49,24 @@
class OpenAPIProvider(Provider):
+ """Provider that creates MCP components from an OpenAPI specification.
+
+ Components are created eagerly during ... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/openapi/provider.py |
Document functions with clear intent |
from __future__ import annotations
from typing import Literal
import httpx
from pydantic import AnyHttpUrl
from starlette.responses import JSONResponse
from starlette.routing import Route
from fastmcp.server.auth import RemoteAuthProvider, TokenVerifier
from fastmcp.server.auth.providers.jwt import JWTVerifier
from... | --- +++ @@ -1,3 +1,9 @@+"""Supabase authentication provider for FastMCP.
+
+This module provides SupabaseProvider - a complete authentication solution that integrates
+with Supabase Auth's JWT verification, supporting Dynamic Client Registration (DCR)
+for seamless MCP client authentication.
+"""
from __future__ imp... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/providers/supabase.py |
Generate NumPy-style docstrings |
from __future__ import annotations
import httpx
from pydantic import AnyHttpUrl
from starlette.responses import JSONResponse
from starlette.routing import Route
from fastmcp.server.auth import RemoteAuthProvider, TokenVerifier
from fastmcp.server.auth.providers.jwt import JWTVerifier
from fastmcp.utilities.auth impo... | --- +++ @@ -1,3 +1,9 @@+"""Scalekit authentication provider for FastMCP.
+
+This module provides ScalekitProvider - a complete authentication solution that integrates
+with Scalekit's OAuth 2.1 and OpenID Connect services, supporting Resource Server
+authentication for seamless MCP client authentication.
+"""
from _... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/providers/scalekit.py |
Expand my code with proper documentation strings |
from __future__ import annotations
import warnings
from typing import Any
import httpx
from fastmcp.server.providers.openapi import (
ComponentFn,
OpenAPIProvider,
RouteMap,
RouteMapFn,
)
from fastmcp.server.server import FastMCP
class FastMCPOpenAPI(FastMCP):
def __init__(
self,
... | --- +++ @@ -1,3 +1,15 @@+"""FastMCPOpenAPI - backwards compatibility wrapper.
+
+This class is deprecated. Use FastMCP with OpenAPIProvider instead:
+
+ from fastmcp import FastMCP
+ from fastmcp.server.providers.openapi import OpenAPIProvider
+ import httpx
+
+ client = httpx.AsyncClient(base_url="https://... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/openapi/server.py |
Add docstrings following best practices |
from __future__ import annotations
import inspect
import types
import warnings
from collections.abc import Callable
from functools import partial
from typing import (
TYPE_CHECKING,
Annotated,
Any,
Literal,
TypeVar,
Union,
get_args,
get_origin,
overload,
)
import mcp.types
from mc... | --- +++ @@ -1,3 +1,8 @@+"""Tool decorator mixin for LocalProvider.
+
+This module provides the ToolDecoratorMixin class that adds tool
+registration functionality to LocalProvider.
+"""
from __future__ import annotations
@@ -48,6 +53,7 @@
def _is_prefab_type(tp: Any) -> bool:
+ """Check if *tp* is or contai... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/local_provider/decorators/tools.py |
Create docstrings for all classes and functions |
from __future__ import annotations
from collections.abc import Sequence
from pathlib import Path
from typing import Literal
from fastmcp.resources.base import Resource
from fastmcp.resources.template import ResourceTemplate
from fastmcp.server.providers.aggregate import AggregateProvider
from fastmcp.server.provider... | --- +++ @@ -1,3 +1,4 @@+"""Directory scanning provider for discovering multiple skills."""
from __future__ import annotations
@@ -16,6 +17,40 @@
class SkillsDirectoryProvider(AggregateProvider):
+ """Provider that scans directories and creates a SkillProvider per skill folder.
+
+ This extends AggregateP... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/skills/directory_provider.py |
Provide clean and structured docstrings |
from __future__ import annotations
import logging
from collections.abc import AsyncIterator, Sequence
from contextlib import AsyncExitStack, asynccontextmanager
from typing import TYPE_CHECKING, TypeVar
from fastmcp.exceptions import NotFoundError
from fastmcp.server.providers.base import Provider
from fastmcp.serve... | --- +++ @@ -1,3 +1,22 @@+"""AggregateProvider for combining multiple providers into one.
+
+This module provides `AggregateProvider`, a utility class that presents
+multiple providers as a single unified provider. Useful when you want to
+combine custom providers without creating a full FastMCP server.
+
+Example:
+ ... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/aggregate.py |
Create documentation for each function signature |
from __future__ import annotations
from typing import TypedDict
import httpx
from pydantic import AnyHttpUrl, SecretStr
from starlette.responses import JSONResponse
from starlette.routing import Route
from fastmcp.server.auth import AccessToken, RemoteAuthProvider
from fastmcp.server.auth.providers.introspection im... | --- +++ @@ -1,3 +1,21 @@+"""PropelAuth authentication provider for FastMCP.
+
+Example:
+ ```python
+ from fastmcp import FastMCP
+ from fastmcp.server.auth.providers.propelauth import PropelAuthProvider
+
+ auth = PropelAuthProvider(
+ auth_url="https://auth.yourdomain.com",
+ introspection_c... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/providers/propelauth.py |
Generate consistent docstrings |
from __future__ import annotations
import base64
import inspect
import time
from collections.abc import Awaitable, Callable, Sequence
from typing import TYPE_CHECKING, Any, cast
from urllib.parse import quote
import mcp.types
from mcp import ServerSession
from mcp.client.session import ClientSession
from mcp.server.... | --- +++ @@ -1,3 +1,9 @@+"""ProxyProvider for proxying to remote MCP servers.
+
+This module provides the `ProxyProvider` class that proxies components from
+a remote MCP server via a client factory. It also provides proxy component
+classes that forward execution to remote servers.
+"""
from __future__ import annota... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/proxy.py |
Replace inline comments with docstrings |
from __future__ import annotations
from collections.abc import Awaitable, Callable, Sequence
from typing import TYPE_CHECKING, Any, TypeVar, cast
import mcp.types
from mcp.shared.exceptions import McpError
from mcp.types import ContentBlock
from pydantic import AnyUrl
from fastmcp.exceptions import DisabledError, N... | --- +++ @@ -1,3 +1,4 @@+"""MCP protocol handler setup and wire-format handlers for FastMCP Server."""
from __future__ import annotations
@@ -28,6 +29,10 @@ cursor: str | None,
page_size: int | None,
) -> tuple[list[PaginateT], str | None]:
+ """Apply pagination to items, raising McpError for invalid c... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/mixins/mcp_operations.py |
Write docstrings describing functionality |
from typing import TYPE_CHECKING
from fastmcp.server.providers.aggregate import AggregateProvider
from fastmcp.server.providers.base import Provider
from fastmcp.server.providers.fastmcp_provider import FastMCPProvider
from fastmcp.server.providers.filesystem import FileSystemProvider
from fastmcp.server.providers.lo... | --- +++ @@ -1,3 +1,29 @@+"""Providers for dynamic MCP components.
+
+This module provides the `Provider` abstraction for providing tools,
+resources, and prompts dynamically at runtime.
+
+Example:
+ ```python
+ from fastmcp import FastMCP
+ from fastmcp.server.providers import Provider
+ from fastmcp.tools... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/__init__.py |
Generate docstrings for this script |
from __future__ import annotations
from collections.abc import AsyncIterator, Sequence
from contextlib import asynccontextmanager
from functools import partial
from typing import TYPE_CHECKING, Literal, cast
from typing_extensions import Self
from fastmcp.prompts.base import Prompt
from fastmcp.resources.base impor... | --- +++ @@ -1,3 +1,30 @@+"""Base Provider class for dynamic MCP components.
+
+This module provides the `Provider` abstraction for providing tools,
+resources, and prompts dynamically at runtime.
+
+Example:
+ ```python
+ from fastmcp import FastMCP
+ from fastmcp.server.providers import Provider
+ from fas... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/base.py |
Help me document legacy Python code |
from __future__ import annotations
import importlib.util
import sys
from dataclasses import dataclass, field
from pathlib import Path
from types import ModuleType
from fastmcp.utilities.components import FastMCPComponent
from fastmcp.utilities.logging import get_logger
logger = get_logger(__name__)
@dataclass
cla... | --- +++ @@ -1,3 +1,10 @@+"""File discovery and module import utilities for filesystem-based routing.
+
+This module provides functions to:
+1. Discover Python files in a directory tree
+2. Import modules (as packages if __init__.py exists, else directly)
+3. Extract decorated components (Tool, Resource, Prompt objects)... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/filesystem_discovery.py |
Generate descriptive docstrings automatically |
from __future__ import annotations
import contextlib
import time
from typing import Literal
import httpx
from key_value.aio.protocols import AsyncKeyValue
from pydantic import AnyHttpUrl
from fastmcp.server.auth import TokenVerifier
from fastmcp.server.auth.auth import AccessToken
from fastmcp.server.auth.oauth_pro... | --- +++ @@ -1,3 +1,23 @@+"""Google OAuth provider for FastMCP.
+
+This module provides a complete Google OAuth integration that's ready to use
+with just a client ID and client secret. It handles all the complexity of
+Google's OAuth flow, token validation, and user management.
+
+Example:
+ ```python
+ from fast... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/providers/google.py |
Document all endpoints with docstrings |
from __future__ import annotations
from collections.abc import Sequence
from typing import Literal, TypeVar
from fastmcp.prompts.base import Prompt
from fastmcp.resources.base import Resource
from fastmcp.resources.template import ResourceTemplate
from fastmcp.server.providers.base import Provider
from fastmcp.serve... | --- +++ @@ -1,3 +1,26 @@+"""LocalProvider for locally-defined MCP components.
+
+This module provides the `LocalProvider` class that manages tools, resources,
+templates, and prompts registered via decorators or direct methods.
+
+LocalProvider can be used standalone and attached to multiple servers:
+
+```python
+from... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/local_provider/local_provider.py |
Create docstrings for API functions |
from __future__ import annotations
from collections.abc import AsyncIterator, Callable
from contextlib import AbstractAsyncContextManager, asynccontextmanager
from typing import TYPE_CHECKING, Any
if TYPE_CHECKING:
from fastmcp.server.server import FastMCP
LifespanFn = Callable[["FastMCP[Any]"], AsyncIterator[... | --- +++ @@ -1,3 +1,46 @@+"""Composable lifespans for FastMCP servers.
+
+This module provides a `@lifespan` decorator for creating composable server lifespans
+that can be combined using the `|` operator.
+
+Example:
+ ```python
+ from fastmcp import FastMCP
+ from fastmcp.server.lifespan import lifespan
+
+ ... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/lifespan.py |
Add docstrings to existing functions |
from __future__ import annotations
import hashlib
import re
from dataclasses import dataclass, field
from pathlib import Path
from typing import Any
@dataclass
class SkillFileInfo:
path: str # Relative path within skill directory
size: int
hash: str # sha256 hash
@dataclass
class SkillInfo:
na... | --- +++ @@ -1,3 +1,4 @@+"""Shared utilities and data structures for skills providers."""
from __future__ import annotations
@@ -10,6 +11,7 @@
@dataclass
class SkillFileInfo:
+ """Information about a file within a skill."""
path: str # Relative path within skill directory
size: int
@@ -18,6 +20,7... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/skills/_common.py |
Add docstrings to clarify complex logic |
from __future__ import annotations
import contextlib
import inspect
import logging
import weakref
from collections.abc import AsyncGenerator, Callable
from contextlib import AsyncExitStack, asynccontextmanager
from contextvars import ContextVar, Token
from dataclasses import dataclass
from datetime import datetime, t... | --- +++ @@ -1,3 +1,9 @@+"""Dependency injection for FastMCP.
+
+DI features (Depends, CurrentContext, CurrentFastMCP) work without pydocket
+using the uncalled-for DI engine. Only task-related dependencies (CurrentDocket,
+CurrentWorker) and background task execution require fastmcp[tasks].
+"""
from __future__ impo... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/dependencies.py |
Replace inline comments with docstrings |
import json
import logging
import time
from collections.abc import Callable
from logging import Logger
from typing import Any
import pydantic_core
from .middleware import CallNext, Middleware, MiddlewareContext
def default_serializer(data: Any) -> str:
return pydantic_core.to_json(data, fallback=str).decode()
... | --- +++ @@ -1,3 +1,4 @@+"""Comprehensive logging middleware for FastMCP servers."""
import json
import logging
@@ -12,10 +13,12 @@
def default_serializer(data: Any) -> str:
+ """The default serializer for Payloads in the logging middleware."""
return pydantic_core.to_json(data, fallback=str).decode()
... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/middleware/logging.py |
Add detailed documentation for each class |
from __future__ import annotations
import json
import re
import warnings
from collections.abc import Callable
from typing import TYPE_CHECKING, Any
import httpx
from mcp.types import ToolAnnotations
from pydantic.networks import AnyUrl
import fastmcp
from fastmcp.resources import (
Resource,
ResourceContent... | --- +++ @@ -1,3 +1,4 @@+"""OpenAPI component classes: Tool, Resource, and ResourceTemplate."""
from __future__ import annotations
@@ -61,6 +62,12 @@
def _extract_mime_type_from_route(route: HTTPRoute) -> str:
+ """Extract the primary MIME type from an HTTPRoute's response definitions.
+
+ Looks for the f... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/openapi/components.py |
Add docstrings for internal functions |
from __future__ import annotations
import contextlib
from typing import Literal
import httpx
from key_value.aio.protocols import AsyncKeyValue
from pydantic import AnyHttpUrl
from fastmcp.server.auth import TokenVerifier
from fastmcp.server.auth.auth import AccessToken
from fastmcp.server.auth.oauth_proxy import OA... | --- +++ @@ -1,3 +1,23 @@+"""GitHub OAuth provider for FastMCP.
+
+This module provides a complete GitHub OAuth integration that's ready to use
+with just a client ID and client secret. It handles all the complexity of
+GitHub's OAuth flow, token validation, and user management.
+
+Example:
+ ```python
+ from fast... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/providers/github.py |
Add structured docstrings to improve clarity | from __future__ import annotations
import logging
from collections.abc import Awaitable, Sequence
from dataclasses import dataclass, field, replace
from datetime import datetime, timezone
from functools import partial
from typing import (
TYPE_CHECKING,
Any,
Generic,
Literal,
Protocol,
runtime_... | --- +++ @@ -45,6 +45,9 @@
@dataclass(kw_only=True, frozen=True)
class MiddlewareContext(Generic[T]):
+ """
+ Unified context for all middleware operations.
+ """
message: T
@@ -63,6 +66,9 @@ def make_middleware_wrapper(
middleware: Middleware, call_next: CallNext[T, R]
) -> CallNext[T, R]:
+ ... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/middleware/middleware.py |
Provide docstrings following PEP 257 |
from __future__ import annotations
import asyncio
import weakref
from collections.abc import AsyncIterator
from contextlib import AsyncExitStack, asynccontextmanager, suppress
from typing import TYPE_CHECKING, Any
import anyio
from uncalled_for import SharedContext
import fastmcp
from fastmcp.utilities.logging impo... | --- +++ @@ -1,3 +1,4 @@+"""Lifespan and Docket task infrastructure for FastMCP Server."""
from __future__ import annotations
@@ -22,13 +23,27 @@
class LifespanMixin:
+ """Mixin providing lifespan and Docket task infrastructure for FastMCP."""
@property
def docket(self: FastMCP) -> Docket | None:... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/mixins/lifespan.py |
Add detailed documentation for each class | import secrets
import time
from mcp.server.auth.provider import (
AccessToken,
AuthorizationCode,
AuthorizationParams,
AuthorizeError,
RefreshToken,
TokenError,
construct_redirect_uri,
)
from mcp.shared.auth import (
OAuthClientInformationFull,
OAuthToken,
)
from pydantic import Any... | --- +++ @@ -29,6 +29,10 @@
class InMemoryOAuthProvider(OAuthProvider):
+ """
+ An in-memory OAuth provider for testing purposes.
+ It simulates the OAuth 2.1 flow locally without external calls.
+ """
def __init__(
self,
@@ -88,6 +92,10 @@ async def authorize(
self, client: ... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/providers/in_memory.py |
Improve documentation using docstrings |
from __future__ import annotations
import asyncio
import ipaddress
import socket
import time
from collections.abc import Mapping
from dataclasses import dataclass
from urllib.parse import urlparse
import httpx
from fastmcp.utilities.logging import get_logger
logger = get_logger(__name__)
def format_ip_for_url(ip... | --- +++ @@ -1,3 +1,10 @@+"""SSRF-safe HTTP utilities for FastMCP.
+
+This module provides SSRF-protected HTTP fetching with:
+- DNS resolution and IP validation before requests
+- DNS pinning to prevent rebinding TOCTOU attacks
+- Support for both CIMD and JWKS fetches
+"""
from __future__ import annotations
@@ -1... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/auth/ssrf.py |
Add docstrings to existing functions |
import time
from collections import defaultdict, deque
from collections.abc import Callable
from typing import Any
import anyio
from mcp import McpError
from mcp.types import ErrorData
from .middleware import CallNext, Middleware, MiddlewareContext
class RateLimitError(McpError):
def __init__(self, message: s... | --- +++ @@ -1,3 +1,4 @@+"""Rate limiting middleware for protecting FastMCP servers from abuse."""
import time
from collections import defaultdict, deque
@@ -12,14 +13,22 @@
class RateLimitError(McpError):
+ """Error raised when rate limit is exceeded."""
def __init__(self, message: str = "Rate limit e... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/middleware/rate_limiting.py |
Add docstrings following best practices | from __future__ import annotations
from dataclasses import dataclass
from enum import Enum
from typing import Any, Generic, Literal, cast, get_origin
from mcp.server.elicitation import (
CancelledElicitation,
DeclinedElicitation,
)
from pydantic import BaseModel
from pydantic.json_schema import GenerateJsonSc... | --- +++ @@ -34,8 +34,15 @@
class ElicitationJsonSchema(GenerateJsonSchema):
+ """Custom JSON schema generator for MCP elicitation that always inlines enums.
+
+ MCP elicitation requires inline enum schemas without $ref/$defs references.
+ This generator ensures enums are always generated inline for compati... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/elicitation.py |
Document functions with detailed explanations |
from __future__ import annotations
from pathlib import Path
from typing import Literal
from fastmcp.server.providers.skills.directory_provider import SkillsDirectoryProvider
class ClaudeSkillsProvider(SkillsDirectoryProvider):
def __init__(
self,
reload: bool = False,
supporting_files:... | --- +++ @@ -1,3 +1,4 @@+"""Claude-specific skills provider for Claude Code skills."""
from __future__ import annotations
@@ -8,6 +9,25 @@
class ClaudeSkillsProvider(SkillsDirectoryProvider):
+ """Provider for Claude Code skills from ~/.claude/skills/.
+
+ A convenience subclass that sets the default root... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/skills/claude_provider.py |
Add professional docstrings to my codebase |
from __future__ import annotations
from collections.abc import Sequence
from typing import TYPE_CHECKING
from fastmcp.server.transforms import GetToolNext, Transform
from fastmcp.tools.tool_transform import ToolTransformConfig
from fastmcp.utilities.versions import VersionSpec
if TYPE_CHECKING:
from fastmcp.too... | --- +++ @@ -1,3 +1,4 @@+"""Transform for applying tool transformations."""
from __future__ import annotations
@@ -13,8 +14,28 @@
class ToolTransform(Transform):
+ """Applies tool transformations to modify tool schemas.
+
+ Wraps ToolTransformConfig to apply argument renames, schema changes,
+ hidden a... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/transforms/tool_transform.py |
Generate docstrings for script automation |
from abc import abstractmethod
from collections.abc import Awaitable, Callable, Sequence
from typing import Annotated, Any
from fastmcp.server.context import Context
from fastmcp.server.transforms import GetToolNext
from fastmcp.server.transforms.catalog import CatalogTransform
from fastmcp.tools.base import Tool, To... | --- +++ @@ -1,3 +1,31 @@+"""Base class for search transforms.
+
+Search transforms replace ``list_tools()`` output with a small set of
+synthetic tools — a search tool and a call-tool proxy — so LLMs can
+discover tools on demand instead of receiving the full catalog.
+
+All concrete search transforms (``RegexSearchTra... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/transforms/search/base.py |
Add docstrings to improve collaboration |
from __future__ import annotations
import json
import logging
import uuid
from datetime import datetime, timezone
from typing import TYPE_CHECKING, Any, cast
import mcp.types
from mcp import ServerSession
logger = logging.getLogger(__name__)
if TYPE_CHECKING:
from fastmcp.server.server import FastMCP
# Redis... | --- +++ @@ -1,3 +1,17 @@+"""Background task elicitation support (SEP-1686).
+
+This module provides elicitation capabilities for background tasks running
+in Docket workers. Unlike regular MCP requests, background tasks don't have
+an active request context, so elicitation requires special handling:
+
+1. Set task stat... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/tasks/elicitation.py |
Generate docstrings for this script |
import re
from collections.abc import Sequence
from typing import Annotated, Any
from fastmcp.server.context import Context
from fastmcp.server.transforms.search.base import (
BaseSearchTransform,
_extract_searchable_text,
)
from fastmcp.tools.base import Tool
class RegexSearchTransform(BaseSearchTransform)... | --- +++ @@ -1,3 +1,4 @@+"""Regex-based search transform."""
import re
from collections.abc import Sequence
@@ -12,6 +13,11 @@
class RegexSearchTransform(BaseSearchTransform):
+ """Search transform using regex pattern matching.
+
+ Tools are matched against their name, description, and parameter
+ infor... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/transforms/search/regex.py |
Fill in missing docstrings in my code |
from __future__ import annotations
import base64
import json
from collections.abc import Sequence
from typing import TYPE_CHECKING, Annotated, Any
from mcp.types import ToolAnnotations
from fastmcp.server.dependencies import get_context
from fastmcp.server.transforms import GetToolNext, Transform
from fastmcp.tools... | --- +++ @@ -1,3 +1,22 @@+"""Transform that exposes resources as tools.
+
+This transform generates tools for listing and reading resources, enabling
+clients that only support tools to access resource functionality.
+
+The generated tools route through `ctx.fastmcp` at runtime, so all server
+middleware (auth, visibili... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/transforms/resources_as_tools.py |
Generate descriptive docstrings automatically |
from __future__ import annotations
import asyncio
import re
import secrets
import warnings
from collections.abc import (
AsyncIterator,
Awaitable,
Callable,
Sequence,
)
from contextlib import (
AbstractAsyncContextManager,
asynccontextmanager,
)
from dataclasses import replace
from functools i... | --- +++ @@ -1,3 +1,4 @@+"""FastMCP - A more ergonomic interface for MCP servers."""
from __future__ import annotations
@@ -124,6 +125,7 @@
def _check_removed_kwargs(kwargs: dict[str, Any]) -> None:
+ """Raise helpful TypeErrors for kwargs removed in v3."""
for key in kwargs:
if key in _REMOVED... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/server.py |
Add detailed docstrings explaining each function |
import hashlib
import math
import re
from collections.abc import Sequence
from typing import Annotated, Any
from fastmcp.server.context import Context
from fastmcp.server.transforms.search.base import (
BaseSearchTransform,
SearchResultSerializer,
_extract_searchable_text,
)
from fastmcp.tools.base import... | --- +++ @@ -1,3 +1,4 @@+"""BM25-based search transform."""
import hashlib
import math
@@ -15,10 +16,12 @@
def _tokenize(text: str) -> list[str]:
+ """Lowercase, split on non-alphanumeric, filter short tokens."""
return [t for t in re.split(r"[^a-z0-9]+", text.lower()) if len(t) > 1]
class _BM25Inde... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/transforms/search/bm25.py |
Add well-formatted docstrings |
from __future__ import annotations
import json
import mimetypes
from collections.abc import Sequence
from pathlib import Path
from typing import Any, Literal, cast
from pydantic import AnyUrl
from fastmcp.resources.base import Resource, ResourceResult
from fastmcp.resources.template import ResourceTemplate
from fas... | --- +++ @@ -1,3 +1,4 @@+"""Basic skill provider for handling a single skill folder."""
from __future__ import annotations
@@ -32,6 +33,7 @@
class SkillResource(Resource):
+ """A resource representing a skill's main file or manifest."""
skill_info: SkillInfo
is_manifest: bool = False
@@ -46,6 +48... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/skills/skill_provider.py |
Write docstrings including parameters and return values |
from importlib.util import find_spec
from mcp.types import (
ServerTasksCapability,
ServerTasksRequestsCapability,
TasksCallCapability,
TasksCancelCapability,
TasksListCapability,
TasksToolsCapability,
)
def _is_docket_available() -> bool:
return find_spec("docket") is not None
def get... | --- +++ @@ -1,3 +1,4 @@+"""SEP-1686 task capabilities declaration."""
from importlib.util import find_spec
@@ -12,10 +13,21 @@
def _is_docket_available() -> bool:
+ """Check if pydocket is installed (local to avoid circular import)."""
return find_spec("docket") is not None
def get_task_capabiliti... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/tasks/capabilities.py |
Document all public functions with docstrings |
from __future__ import annotations
from collections.abc import Sequence
from typing import TYPE_CHECKING, Any, Literal, TypeVar
import mcp.types
from fastmcp.resources.base import Resource
from fastmcp.resources.template import ResourceTemplate
from fastmcp.server.transforms import (
GetPromptNext,
GetResou... | --- +++ @@ -1,3 +1,9 @@+"""Visibility transform for marking component visibility state.
+
+Each Visibility instance marks components via internal metadata. Multiple
+visibility transforms can be stacked - later transforms override earlier ones.
+Final filtering happens at the Provider level.
+"""
from __future__ imp... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/transforms/visibility.py |
Create simple docstrings for beginners |
from __future__ import annotations
import inspect
from collections.abc import Callable
from typing import Any
from mcp.types import TextContent
from mcp.types import Tool as SDKTool
from pydantic import ConfigDict
from fastmcp.exceptions import AuthorizationError
from fastmcp.server.auth.authorization import AuthCo... | --- +++ @@ -1,3 +1,4 @@+"""SamplingTool for use during LLM sampling requests."""
from __future__ import annotations
@@ -20,6 +21,27 @@
class SamplingTool(FastMCPBaseModel):
+ """A tool that can be used during LLM sampling.
+
+ SamplingTools bundle a tool's schema (name, description, parameters) with
+ ... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/sampling/sampling_tool.py |
Write Python docstrings for this snippet |
from __future__ import annotations
import inspect
import json
from collections.abc import Callable, Sequence
from dataclasses import dataclass
from typing import TYPE_CHECKING, Any, Generic, Literal, cast
import anyio
from mcp.types import (
ClientCapabilities,
CreateMessageResult,
CreateMessageResultWit... | --- +++ @@ -1,3 +1,4 @@+"""Sampling types and helper functions for FastMCP servers."""
from __future__ import annotations
@@ -51,6 +52,13 @@
@dataclass
class SamplingResult(Generic[ResultT]):
+ """Result of a sampling operation.
+
+ Attributes:
+ text: The text representation of the result (raw tex... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/sampling/run.py |
Create docstrings for API functions |
from __future__ import annotations
from collections.abc import Sequence
from typing import TYPE_CHECKING
from fastmcp.server.transforms import (
GetPromptNext,
GetResourceNext,
GetResourceTemplateNext,
GetToolNext,
Transform,
)
from fastmcp.utilities.versions import VersionSpec
if TYPE_CHECKING:... | --- +++ @@ -1,3 +1,4 @@+"""Version filter transform for filtering components by version range."""
from __future__ import annotations
@@ -21,6 +22,30 @@
class VersionFilter(Transform):
+ """Filters components by version range.
+
+ When applied to a provider or server, components within the version range
+... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/transforms/version_filter.py |
Add standardized docstrings across the file |
from __future__ import annotations
import re
from collections.abc import Sequence
from typing import TYPE_CHECKING
from fastmcp.server.transforms import (
GetPromptNext,
GetResourceNext,
GetResourceTemplateNext,
GetToolNext,
Transform,
)
from fastmcp.utilities.versions import VersionSpec
if TYPE... | --- +++ @@ -1,3 +1,4 @@+"""Namespace transform for prefixing component names."""
from __future__ import annotations
@@ -25,8 +26,27 @@
class Namespace(Transform):
+ """Prefixes component names with a namespace.
+
+ - Tools: name → namespace_name
+ - Prompts: name → namespace_name
+ - Resources: pro... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/transforms/namespace.py |
Add docstrings to existing functions |
from __future__ import annotations
from collections.abc import AsyncIterator, Sequence
from contextlib import asynccontextmanager
from typing import TYPE_CHECKING
from fastmcp.server.providers.base import Provider
from fastmcp.utilities.versions import VersionSpec
if TYPE_CHECKING:
from fastmcp.prompts.base imp... | --- +++ @@ -1,3 +1,8 @@+"""WrappedProvider for immutable transform composition.
+
+This module provides `_WrappedProvider`, an internal class that wraps a provider
+with an additional transform. Created by `Provider.wrap_transform()`.
+"""
from __future__ import annotations
@@ -18,8 +23,23 @@
class _WrappedPro... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/wrapped_provider.py |
Turn comments into proper docstrings |
from __future__ import annotations
import json
from collections.abc import Sequence
from typing import TYPE_CHECKING, Annotated, Any
from mcp.types import TextContent
from fastmcp.server.dependencies import get_context
from fastmcp.server.transforms import GetToolNext, Transform
from fastmcp.tools.base import Tool
... | --- +++ @@ -1,3 +1,22 @@+"""Transform that exposes prompts as tools.
+
+This transform generates tools for listing and getting prompts, enabling
+clients that only support tools to access prompt functionality.
+
+The generated tools route through `ctx.fastmcp` at runtime, so all server
+middleware (auth, visibility, ra... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/transforms/prompts_as_tools.py |
Add verbose docstrings with examples |
from __future__ import annotations
from pathlib import Path
from typing import Literal
from fastmcp.server.providers.skills.directory_provider import SkillsDirectoryProvider
class CursorSkillsProvider(SkillsDirectoryProvider):
def __init__(
self,
reload: bool = False,
supporting_files:... | --- +++ @@ -1,3 +1,4 @@+"""Vendor-specific skills providers for various AI coding platforms."""
from __future__ import annotations
@@ -8,6 +9,7 @@
class CursorSkillsProvider(SkillsDirectoryProvider):
+ """Cursor skills from ~/.cursor/skills/."""
def __init__(
self,
@@ -25,6 +27,7 @@
clas... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/providers/skills/vendor_providers.py |
Create docstrings for each class method |
from __future__ import annotations
import functools
import inspect
from collections.abc import Callable
from dataclasses import dataclass
from datetime import timedelta
from typing import Any, Literal
from fastmcp.utilities.async_utils import is_coroutine_function
# Task execution modes per SEP-1686 / MCP ToolExecu... | --- +++ @@ -1,3 +1,8 @@+"""TaskConfig for MCP SEP-1686 background task execution modes.
+
+This module defines the configuration for how tools, resources, and prompts
+handle task-augmented execution as specified in SEP-1686.
+"""
from __future__ import annotations
@@ -21,6 +26,15 @@
@dataclass
class TaskMeta:
... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/tasks/config.py |
Create simple docstrings for beginners | from __future__ import annotations as _annotations
import inspect
import os
from datetime import timedelta
from pathlib import Path
from typing import Annotated, Any, Literal
from platformdirs import user_data_dir
from pydantic import Field, field_validator
from pydantic_settings import (
BaseSettings,
Settin... | --- +++ @@ -31,6 +31,7 @@
class DocketSettings(BaseSettings):
+ """Docket worker configuration."""
model_config = SettingsConfigDict(
env_prefix="FASTMCP_DOCKET_",
@@ -133,6 +134,7 @@
class Settings(BaseSettings):
+ """FastMCP settings."""
model_config = SettingsConfigDict(
... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/settings.py |
Generate NumPy-style docstrings |
from typing import Any
from opentelemetry import context as otel_context
from opentelemetry import propagate, trace
from opentelemetry.context import Context
from opentelemetry.trace import Span, Status, StatusCode, Tracer
from opentelemetry.trace import get_tracer as otel_get_tracer
INSTRUMENTATION_NAME = "fastmcp"... | --- +++ @@ -1,3 +1,25 @@+"""OpenTelemetry instrumentation for FastMCP.
+
+This module provides native OpenTelemetry integration for FastMCP servers and clients.
+It uses only the opentelemetry-api package, so telemetry is a no-op unless the user
+installs an OpenTelemetry SDK and configures exporters.
+
+Example usage ... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/telemetry.py |
Generate docstrings for this script |
from __future__ import annotations
from contextlib import suppress
from datetime import datetime, timezone
from typing import TYPE_CHECKING
from docket.execution import ExecutionState
from mcp.types import TaskStatusNotification, TaskStatusNotificationParams
from fastmcp.server.tasks.config import DEFAULT_TTL_MS
fr... | --- +++ @@ -1,3 +1,10 @@+"""Task subscription helpers for sending MCP notifications (SEP-1686).
+
+Subscribes to Docket execution state changes and sends notifications/tasks/status
+to clients when their tasks change state.
+
+This module requires fastmcp[tasks] (pydocket). It is only imported when docket is available.... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/tasks/subscriptions.py |
Document functions with clear intent |
from __future__ import annotations
import itertools
from collections.abc import Sequence
from contextvars import ContextVar
from typing import TYPE_CHECKING
from fastmcp.server.transforms import Transform
from fastmcp.utilities.versions import dedupe_with_versions
if TYPE_CHECKING:
from fastmcp.prompts.base imp... | --- +++ @@ -1,3 +1,46 @@+"""Base class for transforms that need to read the real component catalog.
+
+Some transforms replace ``list_tools()`` output with synthetic components
+(e.g. a search interface) while still needing access to the *real*
+(auth-filtered) catalog at call time. ``CatalogTransform`` provides the
+... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/transforms/catalog.py |
Fill in missing docstrings in my code |
from __future__ import annotations
import hashlib
import json
import re
from collections.abc import Callable, Mapping
from copy import deepcopy
from dataclasses import MISSING, field, make_dataclass
from datetime import datetime
from typing import (
Annotated,
Any,
ForwardRef,
Literal,
Union,
... | --- +++ @@ -1,3 +1,36 @@+"""Convert JSON Schema to Python types with validation.
+
+The json_schema_to_type function converts a JSON Schema into a Python type that can be used
+for validation with Pydantic. It supports:
+
+- Basic types (string, number, integer, boolean, null)
+- Complex types (arrays, objects)
+- Form... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/utilities/json_schema_type.py |
Add docstrings for production code |
from __future__ import annotations
from collections.abc import Awaitable, Sequence
from typing import TYPE_CHECKING, Protocol
from fastmcp.utilities.versions import VersionSpec
if TYPE_CHECKING:
from fastmcp.prompts.base import Prompt
from fastmcp.resources.base import Resource
from fastmcp.resources.te... | --- +++ @@ -1,3 +1,22 @@+"""Transform system for component transformations.
+
+Transforms modify components (tools, resources, prompts). List operations use a pure
+function pattern where transforms receive sequences and return transformed sequences.
+Get operations use a middleware pattern with `call_next` to chain lo... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/transforms/__init__.py |
Provide clean and structured docstrings |
from __future__ import annotations
from typing import TYPE_CHECKING, Any, Literal
import mcp.types
from mcp.shared.exceptions import McpError
from mcp.types import METHOD_NOT_FOUND, ErrorData
from fastmcp.server.tasks.config import TaskMeta
from fastmcp.server.tasks.handlers import submit_to_docket
if TYPE_CHECKIN... | --- +++ @@ -1,3 +1,7 @@+"""Task routing helper for MCP components.
+
+Provides unified task mode enforcement and docket routing logic.
+"""
from __future__ import annotations
@@ -25,6 +29,21 @@ arguments: dict[str, Any] | None = None,
task_meta: TaskMeta | None = None,
) -> mcp.types.CreateTaskResult | N... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/tasks/routing.py |
Write proper docstrings for these functions |
import contextlib
import logging
from typing import Any, Literal, cast
from rich.console import Console
from rich.logging import RichHandler
from typing_extensions import override
import fastmcp
def get_logger(name: str) -> logging.Logger:
if name.startswith("fastmcp."):
return logging.getLogger(name=n... | --- +++ @@ -1,3 +1,4 @@+"""Logging utilities for FastMCP."""
import contextlib
import logging
@@ -11,6 +12,14 @@
def get_logger(name: str) -> logging.Logger:
+ """Get a logger nested under FastMCP namespace.
+
+ Args:
+ name: the name of the logger, which will be prefixed with 'FastMCP.'
+
+ Ret... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/utilities/logging.py |
Add docstrings including usage examples |
from __future__ import annotations
import uuid
from contextlib import suppress
from datetime import datetime, timezone
from typing import TYPE_CHECKING, Any, Literal
import mcp.types
from mcp.shared.exceptions import McpError
from mcp.types import INTERNAL_ERROR, ErrorData
from fastmcp.server.dependencies import _c... | --- +++ @@ -1,3 +1,7 @@+"""SEP-1686 task execution handlers.
+
+Handles queuing tool/prompt/resource executions to Docket as background tasks.
+"""
from __future__ import annotations
@@ -34,6 +38,25 @@ arguments: dict[str, Any] | None = None,
task_meta: TaskMeta | None = None,
) -> mcp.types.CreateTaskRe... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/tasks/handlers.py |
Add return value explanations in docstrings |
from __future__ import annotations
import importlib.metadata
from dataclasses import dataclass
from enum import Enum
from typing import Any, Literal, cast
import pydantic_core
from mcp.server.fastmcp import FastMCP as FastMCP1x
import fastmcp
from fastmcp import Client
from fastmcp.server.server import FastMCP
@d... | --- +++ @@ -1,3 +1,4 @@+"""Utilities for inspecting FastMCP instances."""
from __future__ import annotations
@@ -16,6 +17,7 @@
@dataclass
class ToolInfo:
+ """Information about a tool."""
key: str
name: str
@@ -31,6 +33,7 @@
@dataclass
class PromptInfo:
+ """Information about a prompt."""
... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/utilities/inspect.py |
Add missing documentation to my Python functions |
from collections.abc import Generator
from contextlib import contextmanager
from mcp.server.lowlevel.server import request_ctx
from opentelemetry.context import Context
from opentelemetry.trace import Span, SpanKind, Status, StatusCode
from fastmcp.telemetry import extract_trace_context, get_tracer
def get_auth_sp... | --- +++ @@ -1,3 +1,4 @@+"""Server-side telemetry helpers."""
from collections.abc import Generator
from contextlib import contextmanager
@@ -10,6 +11,7 @@
def get_auth_span_attributes() -> dict[str, str]:
+ """Get auth attributes for the current request, if authenticated."""
from fastmcp.server.dependen... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/server/telemetry.py |
Add docstrings for better understanding |
from __future__ import annotations
from collections.abc import AsyncIterator, Callable, Mapping
from contextlib import AbstractAsyncContextManager, AsyncExitStack, asynccontextmanager
from typing import Any, TypeVar
AppT = TypeVar("AppT")
def combine_lifespans(
*lifespans: Callable[[AppT], AbstractAsyncContext... | --- +++ @@ -1,3 +1,4 @@+"""Lifespan utilities for combining async context manager lifespans."""
from __future__ import annotations
@@ -11,6 +12,36 @@ def combine_lifespans(
*lifespans: Callable[[AppT], AbstractAsyncContextManager[Mapping[str, Any] | None]],
) -> Callable[[AppT], AbstractAsyncContextManager[d... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/utilities/lifespan.py |
Write docstrings for this repository | from __future__ import annotations
from collections import defaultdict
from typing import Any
from jsonref import JsonRefError, replace_refs
def _defs_have_cycles(defs: dict[str, Any]) -> bool:
if not defs:
return False
# Build adjacency: def_name -> set of def_names it references.
edges: dict[... | --- +++ @@ -7,6 +7,13 @@
def _defs_have_cycles(defs: dict[str, Any]) -> bool:
+ """Check whether any definitions in ``$defs`` form a reference cycle.
+
+ A cycle means a definition directly or transitively references itself
+ (e.g. Node → children → Node, or A → B → A). ``jsonref.replace_refs``
+ silen... | https://raw.githubusercontent.com/PrefectHQ/fastmcp/HEAD/src/fastmcp/utilities/json_schema.py |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.