ContextQMD
Back to Fastmcp

oauth_callback

docs/python-sdk/fastmcp-client-oauth_callback.mdx

3.2.42.5 KB
Original Source

fastmcp.client.oauth_callback

OAuth callback server for handling authorization code flows.

This module provides a reusable callback server that can handle OAuth redirects and display styled responses to users.

Functions

create_callback_html <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/client/oauth_callback.py#L34" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
create_callback_html(message: str, is_success: bool = True, title: str = 'FastMCP OAuth', server_url: str | None = None) -> str

Create a styled HTML response for OAuth callbacks.

create_oauth_callback_server <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/client/oauth_callback.py#L103" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
create_oauth_callback_server(port: int, callback_path: str = '/callback', server_url: str | None = None, result_container: OAuthCallbackResult | None = None, result_ready: anyio.Event | None = None) -> Server

Create an OAuth callback server.

Args:

  • port: The port to run the server on
  • callback_path: The path to listen for OAuth redirects on
  • server_url: Optional server URL to display in success messages
  • result_container: Optional container to store callback results
  • result_ready: Optional event to signal when callback is received

Returns:

  • Configured uvicorn Server instance (not yet running)

Classes

CallbackResponse <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/client/oauth_callback.py#L80" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

Methods:

from_dict <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/client/oauth_callback.py#L87" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
from_dict(cls, data: dict[str, str]) -> CallbackResponse

to_dict <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/client/oauth_callback.py#L90" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
to_dict(self) -> dict[str, str]

OAuthCallbackResult <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/client/oauth_callback.py#L95" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

Container for OAuth callback results, used with anyio.Event for async coordination.