Spaces:
Running
Running
Jeremiah Lowin commited on
Commit ·
987be7e
1
Parent(s): 9d287ee
Add middleware kwarg
Browse files- src/fastmcp/server/http.py +48 -30
- src/fastmcp/server/server.py +13 -5
- test.py +0 -12
src/fastmcp/server/http.py
CHANGED
|
@@ -3,7 +3,7 @@ from __future__ import annotations
|
|
| 3 |
from collections.abc import AsyncGenerator, Callable, Generator
|
| 4 |
from contextlib import asynccontextmanager, contextmanager
|
| 5 |
from contextvars import ContextVar
|
| 6 |
-
from typing import TYPE_CHECKING
|
| 7 |
|
| 8 |
from mcp.server.auth.middleware.auth_context import AuthContextMiddleware
|
| 9 |
from mcp.server.auth.middleware.bearer_auth import (
|
|
@@ -19,7 +19,7 @@ from starlette.middleware import Middleware
|
|
| 19 |
from starlette.middleware.authentication import AuthenticationMiddleware
|
| 20 |
from starlette.requests import Request
|
| 21 |
from starlette.responses import Response
|
| 22 |
-
from starlette.routing import Mount, Route
|
| 23 |
from starlette.types import Receive, Scope, Send
|
| 24 |
|
| 25 |
from fastmcp.low_level.sse_server_transport import SseServerTransport
|
|
@@ -64,7 +64,7 @@ class RequestContextMiddleware:
|
|
| 64 |
def setup_auth_middleware_and_routes(
|
| 65 |
auth_server_provider: OAuthAuthorizationServerProvider | None,
|
| 66 |
auth_settings: AuthSettings | None,
|
| 67 |
-
) -> tuple[list[Middleware], list[
|
| 68 |
"""Set up authentication middleware and routes if auth is enabled.
|
| 69 |
|
| 70 |
Args:
|
|
@@ -75,7 +75,7 @@ def setup_auth_middleware_and_routes(
|
|
| 75 |
Tuple of (middleware, auth_routes, required_scopes)
|
| 76 |
"""
|
| 77 |
middleware: list[Middleware] = []
|
| 78 |
-
auth_routes: list[
|
| 79 |
required_scopes: list[str] = []
|
| 80 |
|
| 81 |
if auth_server_provider:
|
|
@@ -108,7 +108,7 @@ def setup_auth_middleware_and_routes(
|
|
| 108 |
|
| 109 |
|
| 110 |
def create_base_app(
|
| 111 |
-
routes: list[
|
| 112 |
middleware: list[Middleware],
|
| 113 |
debug: bool = False,
|
| 114 |
lifespan: Callable | None = None,
|
|
@@ -142,7 +142,8 @@ def create_sse_app(
|
|
| 142 |
auth_server_provider: OAuthAuthorizationServerProvider | None = None,
|
| 143 |
auth_settings: AuthSettings | None = None,
|
| 144 |
debug: bool = False,
|
| 145 |
-
|
|
|
|
| 146 |
) -> Starlette:
|
| 147 |
"""Return an instance of the SSE server app.
|
| 148 |
|
|
@@ -153,11 +154,15 @@ def create_sse_app(
|
|
| 153 |
auth_server_provider: Optional auth provider
|
| 154 |
auth_settings: Optional auth settings
|
| 155 |
debug: Whether to enable debug mode
|
| 156 |
-
|
| 157 |
-
|
| 158 |
Returns:
|
| 159 |
A Starlette application with RequestContextMiddleware
|
| 160 |
"""
|
|
|
|
|
|
|
|
|
|
|
|
|
| 161 |
# Set up SSE transport
|
| 162 |
sse = SseServerTransport(message_path)
|
| 163 |
|
|
@@ -172,24 +177,24 @@ def create_sse_app(
|
|
| 172 |
return Response()
|
| 173 |
|
| 174 |
# Get auth middleware and routes
|
| 175 |
-
|
| 176 |
auth_server_provider, auth_settings
|
| 177 |
)
|
| 178 |
|
| 179 |
-
|
| 180 |
-
|
| 181 |
|
| 182 |
# Add SSE routes with or without auth
|
| 183 |
if auth_server_provider:
|
| 184 |
# Auth is enabled, wrap endpoints with RequireAuthMiddleware
|
| 185 |
-
|
| 186 |
Route(
|
| 187 |
sse_path,
|
| 188 |
endpoint=RequireAuthMiddleware(handle_sse, required_scopes),
|
| 189 |
methods=["GET"],
|
| 190 |
)
|
| 191 |
)
|
| 192 |
-
|
| 193 |
Mount(
|
| 194 |
message_path,
|
| 195 |
app=RequireAuthMiddleware(sse.handle_post_message, required_scopes),
|
|
@@ -200,14 +205,14 @@ def create_sse_app(
|
|
| 200 |
async def sse_endpoint(request: Request) -> Response:
|
| 201 |
return await handle_sse(request.scope, request.receive, request._send) # type: ignore[reportPrivateUsage]
|
| 202 |
|
| 203 |
-
|
| 204 |
Route(
|
| 205 |
sse_path,
|
| 206 |
endpoint=sse_endpoint,
|
| 207 |
methods=["GET"],
|
| 208 |
)
|
| 209 |
)
|
| 210 |
-
|
| 211 |
Mount(
|
| 212 |
message_path,
|
| 213 |
app=sse.handle_post_message,
|
|
@@ -215,13 +220,17 @@ def create_sse_app(
|
|
| 215 |
)
|
| 216 |
|
| 217 |
# Add custom routes with lowest precedence
|
| 218 |
-
if
|
| 219 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 220 |
|
| 221 |
# Create and return the app
|
| 222 |
return create_base_app(
|
| 223 |
-
routes=
|
| 224 |
-
middleware=
|
| 225 |
debug=debug,
|
| 226 |
)
|
| 227 |
|
|
@@ -235,7 +244,8 @@ def create_streamable_http_app(
|
|
| 235 |
json_response: bool = False,
|
| 236 |
stateless_http: bool = False,
|
| 237 |
debug: bool = False,
|
| 238 |
-
|
|
|
|
| 239 |
) -> Starlette:
|
| 240 |
"""Return an instance of the StreamableHTTP server app.
|
| 241 |
|
|
@@ -248,11 +258,15 @@ def create_streamable_http_app(
|
|
| 248 |
json_response: Whether to use JSON response format
|
| 249 |
stateless_http: Whether to use stateless mode (new transport per request)
|
| 250 |
debug: Whether to enable debug mode
|
| 251 |
-
|
|
|
|
| 252 |
|
| 253 |
Returns:
|
| 254 |
A Starlette application with StreamableHTTP support
|
| 255 |
"""
|
|
|
|
|
|
|
|
|
|
| 256 |
# Create session manager using the provided event store
|
| 257 |
session_manager = StreamableHTTPSessionManager(
|
| 258 |
app=server._mcp_server,
|
|
@@ -268,17 +282,17 @@ def create_streamable_http_app(
|
|
| 268 |
await session_manager.handle_request(scope, receive, send)
|
| 269 |
|
| 270 |
# Get auth middleware and routes
|
| 271 |
-
|
| 272 |
auth_server_provider, auth_settings
|
| 273 |
)
|
| 274 |
|
| 275 |
-
|
| 276 |
-
|
| 277 |
|
| 278 |
# Add StreamableHTTP routes with or without auth
|
| 279 |
if auth_server_provider:
|
| 280 |
# Auth is enabled, wrap endpoint with RequireAuthMiddleware
|
| 281 |
-
|
| 282 |
Mount(
|
| 283 |
streamable_http_path,
|
| 284 |
app=RequireAuthMiddleware(handle_streamable_http, required_scopes),
|
|
@@ -286,7 +300,7 @@ def create_streamable_http_app(
|
|
| 286 |
)
|
| 287 |
else:
|
| 288 |
# No auth required
|
| 289 |
-
|
| 290 |
Mount(
|
| 291 |
streamable_http_path,
|
| 292 |
app=handle_streamable_http,
|
|
@@ -294,8 +308,12 @@ def create_streamable_http_app(
|
|
| 294 |
)
|
| 295 |
|
| 296 |
# Add custom routes with lowest precedence
|
| 297 |
-
if
|
| 298 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 299 |
|
| 300 |
# Create a lifespan manager to start and stop the session manager
|
| 301 |
@asynccontextmanager
|
|
@@ -305,8 +323,8 @@ def create_streamable_http_app(
|
|
| 305 |
|
| 306 |
# Create and return the app with lifespan
|
| 307 |
return create_base_app(
|
| 308 |
-
routes=
|
| 309 |
-
middleware=
|
| 310 |
debug=debug,
|
| 311 |
lifespan=lifespan,
|
| 312 |
)
|
|
|
|
| 3 |
from collections.abc import AsyncGenerator, Callable, Generator
|
| 4 |
from contextlib import asynccontextmanager, contextmanager
|
| 5 |
from contextvars import ContextVar
|
| 6 |
+
from typing import TYPE_CHECKING
|
| 7 |
|
| 8 |
from mcp.server.auth.middleware.auth_context import AuthContextMiddleware
|
| 9 |
from mcp.server.auth.middleware.bearer_auth import (
|
|
|
|
| 19 |
from starlette.middleware.authentication import AuthenticationMiddleware
|
| 20 |
from starlette.requests import Request
|
| 21 |
from starlette.responses import Response
|
| 22 |
+
from starlette.routing import BaseRoute, Mount, Route
|
| 23 |
from starlette.types import Receive, Scope, Send
|
| 24 |
|
| 25 |
from fastmcp.low_level.sse_server_transport import SseServerTransport
|
|
|
|
| 64 |
def setup_auth_middleware_and_routes(
|
| 65 |
auth_server_provider: OAuthAuthorizationServerProvider | None,
|
| 66 |
auth_settings: AuthSettings | None,
|
| 67 |
+
) -> tuple[list[Middleware], list[BaseRoute], list[str]]:
|
| 68 |
"""Set up authentication middleware and routes if auth is enabled.
|
| 69 |
|
| 70 |
Args:
|
|
|
|
| 75 |
Tuple of (middleware, auth_routes, required_scopes)
|
| 76 |
"""
|
| 77 |
middleware: list[Middleware] = []
|
| 78 |
+
auth_routes: list[BaseRoute] = []
|
| 79 |
required_scopes: list[str] = []
|
| 80 |
|
| 81 |
if auth_server_provider:
|
|
|
|
| 108 |
|
| 109 |
|
| 110 |
def create_base_app(
|
| 111 |
+
routes: list[BaseRoute],
|
| 112 |
middleware: list[Middleware],
|
| 113 |
debug: bool = False,
|
| 114 |
lifespan: Callable | None = None,
|
|
|
|
| 142 |
auth_server_provider: OAuthAuthorizationServerProvider | None = None,
|
| 143 |
auth_settings: AuthSettings | None = None,
|
| 144 |
debug: bool = False,
|
| 145 |
+
routes: list[BaseRoute] | None = None,
|
| 146 |
+
middleware: list[Middleware] | None = None,
|
| 147 |
) -> Starlette:
|
| 148 |
"""Return an instance of the SSE server app.
|
| 149 |
|
|
|
|
| 154 |
auth_server_provider: Optional auth provider
|
| 155 |
auth_settings: Optional auth settings
|
| 156 |
debug: Whether to enable debug mode
|
| 157 |
+
routes: Optional list of custom routes
|
| 158 |
+
middleware: Optional list of middleware
|
| 159 |
Returns:
|
| 160 |
A Starlette application with RequestContextMiddleware
|
| 161 |
"""
|
| 162 |
+
|
| 163 |
+
server_routes: list[BaseRoute] = []
|
| 164 |
+
server_middleware: list[Middleware] = []
|
| 165 |
+
|
| 166 |
# Set up SSE transport
|
| 167 |
sse = SseServerTransport(message_path)
|
| 168 |
|
|
|
|
| 177 |
return Response()
|
| 178 |
|
| 179 |
# Get auth middleware and routes
|
| 180 |
+
auth_middleware, auth_routes, required_scopes = setup_auth_middleware_and_routes(
|
| 181 |
auth_server_provider, auth_settings
|
| 182 |
)
|
| 183 |
|
| 184 |
+
server_routes.extend(auth_routes)
|
| 185 |
+
server_middleware.extend(auth_middleware)
|
| 186 |
|
| 187 |
# Add SSE routes with or without auth
|
| 188 |
if auth_server_provider:
|
| 189 |
# Auth is enabled, wrap endpoints with RequireAuthMiddleware
|
| 190 |
+
server_routes.append(
|
| 191 |
Route(
|
| 192 |
sse_path,
|
| 193 |
endpoint=RequireAuthMiddleware(handle_sse, required_scopes),
|
| 194 |
methods=["GET"],
|
| 195 |
)
|
| 196 |
)
|
| 197 |
+
server_routes.append(
|
| 198 |
Mount(
|
| 199 |
message_path,
|
| 200 |
app=RequireAuthMiddleware(sse.handle_post_message, required_scopes),
|
|
|
|
| 205 |
async def sse_endpoint(request: Request) -> Response:
|
| 206 |
return await handle_sse(request.scope, request.receive, request._send) # type: ignore[reportPrivateUsage]
|
| 207 |
|
| 208 |
+
server_routes.append(
|
| 209 |
Route(
|
| 210 |
sse_path,
|
| 211 |
endpoint=sse_endpoint,
|
| 212 |
methods=["GET"],
|
| 213 |
)
|
| 214 |
)
|
| 215 |
+
server_routes.append(
|
| 216 |
Mount(
|
| 217 |
message_path,
|
| 218 |
app=sse.handle_post_message,
|
|
|
|
| 220 |
)
|
| 221 |
|
| 222 |
# Add custom routes with lowest precedence
|
| 223 |
+
if routes:
|
| 224 |
+
server_routes.extend(routes)
|
| 225 |
+
|
| 226 |
+
# Add middleware
|
| 227 |
+
if middleware:
|
| 228 |
+
server_middleware.extend(middleware)
|
| 229 |
|
| 230 |
# Create and return the app
|
| 231 |
return create_base_app(
|
| 232 |
+
routes=server_routes,
|
| 233 |
+
middleware=server_middleware,
|
| 234 |
debug=debug,
|
| 235 |
)
|
| 236 |
|
|
|
|
| 244 |
json_response: bool = False,
|
| 245 |
stateless_http: bool = False,
|
| 246 |
debug: bool = False,
|
| 247 |
+
routes: list[BaseRoute] | None = None,
|
| 248 |
+
middleware: list[Middleware] | None = None,
|
| 249 |
) -> Starlette:
|
| 250 |
"""Return an instance of the StreamableHTTP server app.
|
| 251 |
|
|
|
|
| 258 |
json_response: Whether to use JSON response format
|
| 259 |
stateless_http: Whether to use stateless mode (new transport per request)
|
| 260 |
debug: Whether to enable debug mode
|
| 261 |
+
routes: Optional list of custom routes
|
| 262 |
+
middleware: Optional list of middleware
|
| 263 |
|
| 264 |
Returns:
|
| 265 |
A Starlette application with StreamableHTTP support
|
| 266 |
"""
|
| 267 |
+
server_routes: list[BaseRoute] = []
|
| 268 |
+
server_middleware: list[Middleware] = []
|
| 269 |
+
|
| 270 |
# Create session manager using the provided event store
|
| 271 |
session_manager = StreamableHTTPSessionManager(
|
| 272 |
app=server._mcp_server,
|
|
|
|
| 282 |
await session_manager.handle_request(scope, receive, send)
|
| 283 |
|
| 284 |
# Get auth middleware and routes
|
| 285 |
+
auth_middleware, auth_routes, required_scopes = setup_auth_middleware_and_routes(
|
| 286 |
auth_server_provider, auth_settings
|
| 287 |
)
|
| 288 |
|
| 289 |
+
server_routes.extend(auth_routes)
|
| 290 |
+
server_middleware.extend(auth_middleware)
|
| 291 |
|
| 292 |
# Add StreamableHTTP routes with or without auth
|
| 293 |
if auth_server_provider:
|
| 294 |
# Auth is enabled, wrap endpoint with RequireAuthMiddleware
|
| 295 |
+
server_routes.append(
|
| 296 |
Mount(
|
| 297 |
streamable_http_path,
|
| 298 |
app=RequireAuthMiddleware(handle_streamable_http, required_scopes),
|
|
|
|
| 300 |
)
|
| 301 |
else:
|
| 302 |
# No auth required
|
| 303 |
+
server_routes.append(
|
| 304 |
Mount(
|
| 305 |
streamable_http_path,
|
| 306 |
app=handle_streamable_http,
|
|
|
|
| 308 |
)
|
| 309 |
|
| 310 |
# Add custom routes with lowest precedence
|
| 311 |
+
if routes:
|
| 312 |
+
server_routes.extend(routes)
|
| 313 |
+
|
| 314 |
+
# Add middleware
|
| 315 |
+
if middleware:
|
| 316 |
+
server_middleware.extend(middleware)
|
| 317 |
|
| 318 |
# Create a lifespan manager to start and stop the session manager
|
| 319 |
@asynccontextmanager
|
|
|
|
| 323 |
|
| 324 |
# Create and return the app with lifespan
|
| 325 |
return create_base_app(
|
| 326 |
+
routes=server_routes,
|
| 327 |
+
middleware=server_middleware,
|
| 328 |
debug=debug,
|
| 329 |
lifespan=lifespan,
|
| 330 |
)
|
src/fastmcp/server/server.py
CHANGED
|
@@ -35,9 +35,10 @@ from mcp.types import ResourceTemplate as MCPResourceTemplate
|
|
| 35 |
from mcp.types import Tool as MCPTool
|
| 36 |
from pydantic import AnyUrl
|
| 37 |
from starlette.applications import Starlette
|
|
|
|
| 38 |
from starlette.requests import Request
|
| 39 |
from starlette.responses import Response
|
| 40 |
-
from starlette.routing import Route
|
| 41 |
|
| 42 |
import fastmcp.server
|
| 43 |
import fastmcp.settings
|
|
@@ -147,7 +148,7 @@ class FastMCP(Generic[LifespanResultT]):
|
|
| 147 |
)
|
| 148 |
self._auth_server_provider = auth_server_provider
|
| 149 |
|
| 150 |
-
self._additional_http_routes: list[
|
| 151 |
self.dependencies = self.settings.dependencies
|
| 152 |
|
| 153 |
# Set up MCP protocol handlers
|
|
@@ -744,6 +745,7 @@ class FastMCP(Generic[LifespanResultT]):
|
|
| 744 |
self,
|
| 745 |
path: str | None = None,
|
| 746 |
message_path: str | None = None,
|
|
|
|
| 747 |
) -> Starlette:
|
| 748 |
"""Return an instance of the SSE server app."""
|
| 749 |
return create_sse_app(
|
|
@@ -753,10 +755,15 @@ class FastMCP(Generic[LifespanResultT]):
|
|
| 753 |
auth_server_provider=self._auth_server_provider,
|
| 754 |
auth_settings=self.settings.auth,
|
| 755 |
debug=self.settings.debug,
|
| 756 |
-
|
|
|
|
| 757 |
)
|
| 758 |
|
| 759 |
-
def streamable_http_app(
|
|
|
|
|
|
|
|
|
|
|
|
|
| 760 |
"""Return an instance of the StreamableHTTP server app."""
|
| 761 |
from fastmcp.server.http import create_streamable_http_app
|
| 762 |
|
|
@@ -769,7 +776,8 @@ class FastMCP(Generic[LifespanResultT]):
|
|
| 769 |
json_response=self.settings.json_response,
|
| 770 |
stateless_http=self.settings.stateless_http,
|
| 771 |
debug=self.settings.debug,
|
| 772 |
-
|
|
|
|
| 773 |
)
|
| 774 |
|
| 775 |
async def run_streamable_http_async(
|
|
|
|
| 35 |
from mcp.types import Tool as MCPTool
|
| 36 |
from pydantic import AnyUrl
|
| 37 |
from starlette.applications import Starlette
|
| 38 |
+
from starlette.middleware import Middleware
|
| 39 |
from starlette.requests import Request
|
| 40 |
from starlette.responses import Response
|
| 41 |
+
from starlette.routing import BaseRoute, Route
|
| 42 |
|
| 43 |
import fastmcp.server
|
| 44 |
import fastmcp.settings
|
|
|
|
| 148 |
)
|
| 149 |
self._auth_server_provider = auth_server_provider
|
| 150 |
|
| 151 |
+
self._additional_http_routes: list[BaseRoute] = []
|
| 152 |
self.dependencies = self.settings.dependencies
|
| 153 |
|
| 154 |
# Set up MCP protocol handlers
|
|
|
|
| 745 |
self,
|
| 746 |
path: str | None = None,
|
| 747 |
message_path: str | None = None,
|
| 748 |
+
middleware: list[Middleware] | None = None,
|
| 749 |
) -> Starlette:
|
| 750 |
"""Return an instance of the SSE server app."""
|
| 751 |
return create_sse_app(
|
|
|
|
| 755 |
auth_server_provider=self._auth_server_provider,
|
| 756 |
auth_settings=self.settings.auth,
|
| 757 |
debug=self.settings.debug,
|
| 758 |
+
routes=self._additional_http_routes,
|
| 759 |
+
middleware=middleware,
|
| 760 |
)
|
| 761 |
|
| 762 |
+
def streamable_http_app(
|
| 763 |
+
self,
|
| 764 |
+
path: str | None = None,
|
| 765 |
+
middleware: list[Middleware] | None = None,
|
| 766 |
+
) -> Starlette:
|
| 767 |
"""Return an instance of the StreamableHTTP server app."""
|
| 768 |
from fastmcp.server.http import create_streamable_http_app
|
| 769 |
|
|
|
|
| 776 |
json_response=self.settings.json_response,
|
| 777 |
stateless_http=self.settings.stateless_http,
|
| 778 |
debug=self.settings.debug,
|
| 779 |
+
routes=self._additional_http_routes,
|
| 780 |
+
middleware=middleware,
|
| 781 |
)
|
| 782 |
|
| 783 |
async def run_streamable_http_async(
|
test.py
DELETED
|
@@ -1,12 +0,0 @@
|
|
| 1 |
-
from fastmcp import FastMCP
|
| 2 |
-
|
| 3 |
-
mcp = FastMCP()
|
| 4 |
-
|
| 5 |
-
if __name__ == "__main__":
|
| 6 |
-
mcp.run(
|
| 7 |
-
transport="streamable-http",
|
| 8 |
-
host="127.0.0.1",
|
| 9 |
-
port=4200,
|
| 10 |
-
path="/my-custom-path/",
|
| 11 |
-
log_level="debug",
|
| 12 |
-
)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|