From 7941617a8f3308a7beaebc5994a79d9a09bab0b1 Mon Sep 17 00:00:00 2001 From: Sun-ZhenXing <1006925066@qq.com> Date: Mon, 21 Jul 2025 11:44:33 +0800 Subject: [PATCH] chore: move ws support to feat-ws --- README.md | 5 +- README.zh.md | 5 +- src/mcp_template_python/app/math.py | 7 +- src/mcp_template_python/lib/__init__.py | 0 src/mcp_template_python/lib/better_mcp.py | 159 ---------------------- src/mcp_template_python/server.py | 4 +- 6 files changed, 9 insertions(+), 171 deletions(-) delete mode 100644 src/mcp_template_python/lib/__init__.py delete mode 100644 src/mcp_template_python/lib/better_mcp.py diff --git a/README.md b/README.md index 3dfaf89..005620b 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,7 @@ This project provides an MCP application template integrated with FastAPI. - [x] Support for SSE / StreamableHTTP / WebSocket - [x] Support for packaging and distribution -Starting from v0.1.2, we use `BetterFastMCP` to replace `FastMCP`, providing more comprehensive features than the official `FastMCP`: - -- [x] Support for Pydantic models as input parameters, enabling more complex input parameter types and convenient description addition -- [x] Support for WebSocket as transport layer, access by `/{mcp_name}/websocket/ws` +To use WebSocket, you need to switch to the `feat-ws` branch. ## Getting Started diff --git a/README.zh.md b/README.zh.md index 23263b5..a2f9cd4 100644 --- a/README.zh.md +++ b/README.zh.md @@ -9,10 +9,7 @@ - [x] 支持 SSE / StreamableHTTP / WebSocket 兼容 - [x] 支持打包分发 -从 v0.1.2 开始，我们使用 `BetterFastMCP` 替换 `FastMCP`，提供比官方 `FastMCP` 更完善的功能： - -- [x] 支持入参为 Pydantic 模型，以便支持更复杂的输入参数类型并方便添加描述 -- [x] 支持 WebSocket 作为传输层，通过 `/{mcp_name}/websocket/ws` 访问 +为了使用 WebSocket，你需要切换到 `feat-ws` 分支。 ## 开始 diff --git a/src/mcp_template_python/app/math.py b/src/mcp_template_python/app/math.py index 36ee973..ec0e025 100644 --- a/src/mcp_template_python/app/math.py +++ b/src/mcp_template_python/app/math.py @@ -1,9 +1,10 @@ from operator import add, mul, sub, truediv -from ..config import settings -from ..lib.better_mcp import BetterFastMCP +from mcp.server.fastmcp import FastMCP -mcp = BetterFastMCP("math", settings=settings.instructions) +from ..config import settings + +mcp = FastMCP("math", settings=settings.instructions) @mcp.tool() diff --git a/src/mcp_template_python/lib/__init__.py b/src/mcp_template_python/lib/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/src/mcp_template_python/lib/better_mcp.py b/src/mcp_template_python/lib/better_mcp.py deleted file mode 100644 index d36c46c..0000000 --- a/src/mcp_template_python/lib/better_mcp.py +++ /dev/null @@ -1,159 +0,0 @@ -import logging -from typing import Literal - -from mcp.server.auth.middleware.auth_context import AuthContextMiddleware -from mcp.server.auth.middleware.bearer_auth import ( - BearerAuthBackend, - RequireAuthMiddleware, -) -from mcp.server.fastmcp import FastMCP -from mcp.server.websocket import websocket_server -from starlette.applications import Starlette -from starlette.middleware import Middleware -from starlette.middleware.authentication import AuthenticationMiddleware -from starlette.routing import Mount, Route -from starlette.websockets import WebSocket - -from ..config import settings - -logger = logging.getLogger(__name__) - - -class BetterFastMCP(FastMCP): - def run( - self, - transport: Literal["stdio", "sse", "streamable-http", "ws"] = "stdio", - mount_path: str | None = None, - ) -> None: - import anyio - - if transport == "ws": - anyio.run(self.run_ws_async) - else: - super().run(transport=transport, mount_path=mount_path) - - async def run_ws_async(self) -> None: - """Run the server using WebSocket transport.""" - import uvicorn - - starlette_app = self.ws_app() - - config = uvicorn.Config( - app=starlette_app, - host=self.settings.host, - port=self.settings.port, - log_level=self.settings.log_level.lower(), - ) - server = uvicorn.Server(config) - await server.serve() - - def ws_app(self) -> Starlette: - """Return an instance of the Websocket server app.""" - - async def handle_ws(websocket: WebSocket): - async with websocket_server( - websocket.scope, websocket.receive, websocket.send - ) as (ws_read_stream, ws_write_stream): - await self._mcp_server.run( - ws_read_stream, - ws_write_stream, - self._mcp_server.create_initialization_options(), - raise_exceptions=self.settings.debug, - ) - - # Create routes - routes: list[Route | Mount] = [] - middleware: list[Middleware] = [] - required_scopes = [] - - # Set up auth if configured - if self.settings.auth: - required_scopes = self.settings.auth.required_scopes or [] - - # Add auth middleware if token verifier is available - if self._token_verifier: - middleware = [ - Middleware( - AuthenticationMiddleware, - backend=BearerAuthBackend(self._token_verifier), - ), - Middleware(AuthContextMiddleware), - ] - - # Add auth endpoints if auth server provider is configured - if self._auth_server_provider: - from mcp.server.auth.routes import create_auth_routes - - routes.extend( - create_auth_routes( - provider=self._auth_server_provider, - issuer_url=self.settings.auth.issuer_url, - service_documentation_url=self.settings.auth.service_documentation_url, - client_registration_options=self.settings.auth.client_registration_options, - revocation_options=self.settings.auth.revocation_options, - ) - ) - - # Set up routes with or without auth - if self._token_verifier: - # Determine resource metadata URL - resource_metadata_url = None - if self.settings.auth and self.settings.auth.resource_server_url: - from pydantic import AnyHttpUrl - - resource_metadata_url = AnyHttpUrl( - str(self.settings.auth.resource_server_url).rstrip("/") - + "/.well-known/oauth-protected-resource" - ) - - routes.append( - Route( - settings.websocket_path, - endpoint=RequireAuthMiddleware( - handle_ws, required_scopes, resource_metadata_url - ), - ) - ) - else: - # Auth is disabled, no wrapper needed - routes.append( - Route( - settings.websocket_path, - endpoint=handle_ws, - ) - ) - - # Add protected resource metadata endpoint if configured as RS - if self.settings.auth and self.settings.auth.resource_server_url: - from mcp.server.auth.handlers.metadata import ( - ProtectedResourceMetadataHandler, - ) - from mcp.server.auth.routes import cors_middleware - from mcp.shared.auth import ProtectedResourceMetadata - - protected_resource_metadata = ProtectedResourceMetadata( - resource=self.settings.auth.resource_server_url, - authorization_servers=[self.settings.auth.issuer_url], - scopes_supported=self.settings.auth.required_scopes, - ) - routes.append( - Route( - "/.well-known/oauth-protected-resource", - endpoint=cors_middleware( - ProtectedResourceMetadataHandler( - protected_resource_metadata - ).handle, - ["GET", "OPTIONS"], - ), - methods=["GET", "OPTIONS"], - ) - ) - - routes.extend(self._custom_starlette_routes) - - return Starlette( - debug=self.settings.debug, - routes=routes, - middleware=middleware, - lifespan=lambda app: self.session_manager.run(), - ) diff --git a/src/mcp_template_python/server.py b/src/mcp_template_python/server.py index 2ab391a..820d434 100644 --- a/src/mcp_template_python/server.py +++ b/src/mcp_template_python/server.py @@ -50,4 +50,6 @@ for name, mcp in MCP_MAP.items(): if settings.enable_streamable_http: app.mount(f"/{name}", mcp.streamable_http_app()) if settings.enable_websocket: - app.mount(f"/{name}/websocket", mcp.ws_app()) + raise NotImplementedError( + "To use WebSocket, you need to switch to the `feat-ws` branch." + )