From bab1073da2f2ebabce0cfdabc704df51e1f536d9 Mon Sep 17 00:00:00 2001 From: "marvin-context-protocol[bot]" <225465937+marvin-context-protocol[bot]@users.noreply.github.com> Date: Fri, 14 Aug 2026 13:15:03 -0400 Subject: [PATCH] chore: Update SDK documentation (#4832) --- .../fastmcp-server-dependencies.mdx | 89 ++++++++++--------- 1 file changed, 46 insertions(+), 43 deletions(-) diff --git a/docs/python-sdk/fastmcp-server-dependencies.mdx b/docs/python-sdk/fastmcp-server-dependencies.mdx index 1ab291fb1..42de8e80c 100644 --- a/docs/python-sdk/fastmcp-server-dependencies.mdx +++ b/docs/python-sdk/fastmcp-server-dependencies.mdx @@ -16,7 +16,7 @@ using the uncalled-for DI engine. The docket-specific dependencies ## Functions -### `bind_request_context` +### `bind_request_context` ```python bind_request_context(ctx: ServerRequestContext) -> Generator[FastMCPRequestContext, None, None] @@ -31,7 +31,7 @@ initialize middleware enters this so ``Context`` and dependency helpers can read the active request from the ContextVar. -### `extract_version_spec` +### `extract_version_spec` ```python extract_version_spec(meta: dict[str, Any] | None) -> str | None @@ -41,7 +41,7 @@ extract_version_spec(meta: dict[str, Any] | None) -> str | None Extract the FastMCP component version from a lifted ``_meta`` block. -### `set_background_context_factory` +### `set_background_context_factory` ```python set_background_context_factory(factory: Callable[[], Awaitable[Context | None]] | None) -> None @@ -56,7 +56,7 @@ no task context. Passing ``None`` restores core's no-worker-fallback behavior. -### `set_worker_server_resolver` +### `set_worker_server_resolver` ```python set_worker_server_resolver(resolver: Callable[[], FastMCP | None] | None) -> None @@ -66,7 +66,7 @@ set_worker_server_resolver(resolver: Callable[[], FastMCP | None] | None) -> Non Install (or clear) the worker-server resolver used by ``get_server()``. -### `is_docket_available` +### `is_docket_available` ```python is_docket_available() -> bool @@ -87,7 +87,7 @@ Any of those failing means we treat docket as unavailable and fall back to the no-tasks code paths instead of crashing deep inside a request. -### `transform_context_annotations` +### `transform_context_annotations` ```python transform_context_annotations(fn: Callable[..., Any]) -> Callable[..., Any] @@ -114,7 +114,7 @@ allows them to have defaults in any order. - Function with modified signature (same function object, updated __signature__) -### `get_context` +### `get_context` ```python get_context() -> Context @@ -124,7 +124,7 @@ get_context() -> Context Get the current FastMCP Context instance directly. -### `get_server` +### `get_server` ```python get_server() -> FastMCP @@ -144,7 +144,7 @@ root that started the worker (#3571). - `RuntimeError`: If no server in context -### `get_session` +### `get_session` ```python get_session(session_id: str) -> Session @@ -169,7 +169,7 @@ no foreground context — it works from a `task=True` tool's Docket worker as well as a normal request. -### `get_http_request` +### `get_http_request` ```python get_http_request() -> Request @@ -181,7 +181,7 @@ Get the current HTTP request. Tries MCP SDK's request_ctx first, then falls back to FastMCP's HTTP context. -### `get_http_headers` +### `get_http_headers` ```python get_http_headers(include_all: bool = False, include: set[str] | None = None) -> dict[str, str] @@ -202,7 +202,7 @@ normally be excluded. This is useful for proxy transports that need to forward authorization headers to upstream MCP servers. -### `get_access_token` +### `get_access_token` ```python get_access_token() -> AccessToken | None @@ -220,7 +220,7 @@ request is available. - The access token if an authenticated user is available, None otherwise. -### `without_injected_parameters` +### `without_injected_parameters` ```python without_injected_parameters(fn: Callable[..., Any]) -> Callable[..., Any] @@ -249,7 +249,7 @@ thread-affinity libraries (e.g. Windows COM). Ignored for async fns. - Async wrapper function without injected parameters -### `resolve_dependencies` +### `resolve_dependencies` ```python resolve_dependencies(fn: Callable[..., Any], arguments: dict[str, Any]) -> AsyncGenerator[dict[str, Any], None] @@ -264,6 +264,9 @@ This function: The filtering prevents external callers from overriding injected parameters by providing values for dependency parameter names. This is a security feature. +The filtered arguments also feed the resolution frame, so a CallArgument() +reference to a dependency parameter resolves the dependency and never a +caller-supplied value. Note: Context injection is handled via transform_context_annotations() which converts `ctx: Context` to `ctx: Context = Depends(get_context)` at registration @@ -275,7 +278,7 @@ time, so all injection goes through the unified DI system. which will be filtered out) -### `CurrentContext` +### `CurrentContext` ```python CurrentContext() -> Context @@ -294,7 +297,7 @@ current MCP operation (tool/resource/prompt call). - `RuntimeError`: If no active context found (during resolution) -### `OptionalCurrentContext` +### `OptionalCurrentContext` ```python OptionalCurrentContext() -> Context | None @@ -304,7 +307,7 @@ OptionalCurrentContext() -> Context | None Get the current FastMCP Context, or None when no context is active. -### `CurrentFastMCP` +### `CurrentFastMCP` ```python CurrentFastMCP() -> FastMCP @@ -322,7 +325,7 @@ This dependency provides access to the active FastMCP server. - `RuntimeError`: If no server in context (during resolution) -### `CurrentRequest` +### `CurrentRequest` ```python CurrentRequest() -> Request @@ -342,7 +345,7 @@ current HTTP request. Only available when running over HTTP transports - `RuntimeError`: If no HTTP request in context (e.g., STDIO transport) -### `CurrentHeaders` +### `CurrentHeaders` ```python CurrentHeaders() -> dict[str, str] @@ -360,7 +363,7 @@ transport. - A dependency that resolves to a dictionary of header name -> value -### `CurrentAccessToken` +### `CurrentAccessToken` ```python CurrentAccessToken() -> AccessToken @@ -379,7 +382,7 @@ authenticated request. Raises an error if no authentication is present. - `RuntimeError`: If no authenticated user (use get_access_token() for optional) -### `TokenClaim` +### `TokenClaim` ```python TokenClaim(name: str) -> str @@ -404,7 +407,7 @@ without needing the full token object. ## Classes -### `FastMCPRequestContext` +### `FastMCPRequestContext` FastMCP-owned wrapper around the SDK's per-request context. @@ -422,7 +425,7 @@ distributed-trace parent. Those live in the raw params dict under ``_meta``, which this wrapper lifts once so downstream consumers have a stable surface. -### `ProgressLike` +### `ProgressLike` Protocol for progress tracking interface. @@ -433,7 +436,7 @@ and Docket's Progress (worker context). **Methods:** -#### `current` +#### `current` ```python current(self) -> int | None @@ -442,7 +445,7 @@ current(self) -> int | None Current progress value. -#### `total` +#### `total` ```python total(self) -> int @@ -451,7 +454,7 @@ total(self) -> int Total/target progress value. -#### `message` +#### `message` ```python message(self) -> str | None @@ -460,7 +463,7 @@ message(self) -> str | None Current progress message. -#### `set_total` +#### `set_total` ```python set_total(self, total: int) -> None @@ -469,7 +472,7 @@ set_total(self, total: int) -> None Set the total/target value for progress tracking. -#### `increment` +#### `increment` ```python increment(self, amount: int = 1) -> None @@ -478,7 +481,7 @@ increment(self, amount: int = 1) -> None Atomically increment the current progress value. -#### `set_message` +#### `set_message` ```python set_message(self, message: str | None) -> None @@ -487,7 +490,7 @@ set_message(self, message: str | None) -> None Update the progress status message. -### `InMemoryProgress` +### `InMemoryProgress` In-memory progress tracker for immediate tool execution. @@ -499,25 +502,25 @@ progress doesn't need to be observable across processes. **Methods:** -#### `current` +#### `current` ```python current(self) -> int | None ``` -#### `total` +#### `total` ```python total(self) -> int ``` -#### `message` +#### `message` ```python message(self) -> str | None ``` -#### `set_total` +#### `set_total` ```python set_total(self, total: int) -> None @@ -526,7 +529,7 @@ set_total(self, total: int) -> None Set the total/target value for progress tracking. -#### `increment` +#### `increment` ```python increment(self, amount: int = 1) -> None @@ -535,7 +538,7 @@ increment(self, amount: int = 1) -> None Atomically increment the current progress value. -#### `set_message` +#### `set_message` ```python set_message(self, message: str | None) -> None @@ -544,7 +547,7 @@ set_message(self, message: str | None) -> None Update the progress status message. -### `Progress` +### `Progress` Progress dependency that works in both server and worker contexts. @@ -559,7 +562,7 @@ share mutable state. **Methods:** -#### `current` +#### `current` ```python current(self) -> int | None @@ -568,7 +571,7 @@ current(self) -> int | None Current progress value. -#### `total` +#### `total` ```python total(self) -> int @@ -577,7 +580,7 @@ total(self) -> int Total/target progress value. -#### `message` +#### `message` ```python message(self) -> str | None @@ -586,7 +589,7 @@ message(self) -> str | None Current progress message. -#### `set_total` +#### `set_total` ```python set_total(self, total: int) -> None @@ -595,7 +598,7 @@ set_total(self, total: int) -> None Set the total/target value for progress tracking. -#### `increment` +#### `increment` ```python increment(self, amount: int = 1) -> None @@ -604,7 +607,7 @@ increment(self, amount: int = 1) -> None Atomically increment the current progress value. -#### `set_message` +#### `set_message` ```python set_message(self, message: str | None) -> None