http
fastmcp.server.http
Functions
set_http_request
setup_auth_middleware_and_routes
Set up authentication middleware and routes if auth is enabled.
Args:
auth
: The OAuthProvider authorization server provider
Returns:
- Tuple of (middleware, auth_routes, required_scopes)
create_base_app
Create a base Starlette app with common middleware and routes.
Args:
routes
: List of routes to include in the appmiddleware
: List of middleware to include in the appdebug
: Whether to enable debug modelifespan
: Optional lifespan manager for the app
Returns:
- A Starlette application
create_sse_app
Return an instance of the SSE server app.
Args:
server
: The FastMCP server instancemessage_path
: Path for SSE messagessse_path
: Path for SSE connectionsauth
: Optional auth providerdebug
: Whether to enable debug moderoutes
: Optional list of custom routesmiddleware
: Optional list of middleware
Returns: A Starlette application with RequestContextMiddleware
create_streamable_http_app
Return an instance of the StreamableHTTP server app.
Args:
server
: The FastMCP server instancestreamable_http_path
: Path for StreamableHTTP connectionsevent_store
: Optional event store for session managementauth
: Optional auth providerjson_response
: Whether to use JSON response formatstateless_http
: Whether to use stateless mode (new transport per request)debug
: Whether to enable debug moderoutes
: Optional list of custom routesmiddleware
: Optional list of middleware
Returns:
- A Starlette application with StreamableHTTP support
Classes
StarletteWithLifespan
Methods:
lifespan
RequestContextMiddleware
Middleware that stores each request in a ContextVar