FastAPI MCP SSE

<p align="center"> <strong>English</strong> | <a href="/README.zh-CN.md">简体中文</a> </p>

一个使用 FastAPI 框架并集成 模型上下文协议 (MCP) 的服务器发送事件 (SSE) 实现。

什么是 MCP？

模型上下文协议 (MCP) 是一个开放标准，它使 AI 模型能够与外部工具和数据源进行交互。 MCP 解决了 AI 开发中的几个关键挑战：

• 上下文限制：允许模型访问超出其训练数据的最新信息
• 工具集成：为模型提供使用外部工具和 API 的标准化方式
• 互操作性：在不同的 AI 模型和工具之间创建通用接口
• 可扩展性：可以轻松地向 AI 系统添加新功能，而无需重新训练

本项目演示了如何在 FastAPI Web 应用程序中使用服务器发送事件 (SSE) 实现 MCP。

描述

本项目演示了如何在 FastAPI 框架中使用服务器发送事件 (SSE)，同时集成模型上下文协议 (MCP) 功能。 关键特性是在包含自定义路由的完整 FastAPI Web 应用程序中无缝集成 MCP 的 SSE 功能。

特性

• 使用 MCP 的服务器发送事件 (SSE) 实现
• 与自定义路由的 FastAPI 框架集成
• 具有 MCP 和标准 Web 端点的统一 Web 应用程序
• 可定制的路由结构
• MCP 和 Web 功能之间清晰的关注点分离

架构

本项目展示了一个模块化架构，该架构：

1. 将 MCP SSE 端点（/sse 和 /messages/）集成到 FastAPI 应用程序中
2. 提供标准 Web 路由（/、/about、/status、/docs、/redoc）
3. 演示如何保持 MCP 功能和 Web 路由之间的分离

安装 & 使用选项

前提条件

安装 UV 包管理器 - 一个用 Rust 编写的快速 Python 包安装程序：

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

选项 1：无需安装快速运行

使用 UV 的执行工具直接运行应用程序，无需克隆存储库：

uvx --from git+https://github.com/panz2018/fastapi_mcp_sse.git start

选项 2：完整安装

创建虚拟环境

为项目创建一个隔离的 Python 环境：

uv venv

激活虚拟环境

激活虚拟环境以使用它：

.venv\Scripts\activate

安装依赖项

安装所有必需的软件包：

uv pip install -r pyproject.toml

启动集成服务器

启动具有 MCP SSE 功能的集成 FastAPI 服务器：

python src/server.py

或者

uv run start

可用端点

启动服务器后（使用选项 1 或选项 2），以下端点将可用：

• 主服务器：http://localhost:8000
• 标准 Web 路由：
  • 主页：http://localhost:8000/
  • 关于页面：http://localhost:8000/about
  • 状态 API：http://localhost:8000/status
  • 文档（Swagger UI）：http://localhost:8000/docs
  • 文档（ReDoc）：http://localhost:8000/redoc
• MCP SSE 端点：
  • SSE 端点：http://localhost:8000/sse
  • 消息发布：http://localhost:8000/messages/

使用 MCP Inspector 调试

对于测试和调试 MCP 功能，请使用 MCP Inspector：

mcp dev ./src/weather.py

连接到 MCP Inspector

1. 在 http://localhost:5173 打开 MCP Inspector
2. 配置连接：
   • 将传输类型设置为 SSE
   • 输入 URL：http://localhost:8000/sse
   • 点击 Connect

测试函数

1. 导航到 Tools 部分
2. 点击 List Tools 查看可用函数：
   • get_alerts：获取天气警报
   • get_forcast：获取天气预报
3. 选择一个函数
4. 输入所需的参数
5. 点击 Run Tool 执行

扩展应用程序

添加自定义路由

应用程序结构使使用 FastAPI 的 APIRouter 轻松添加新路由：

1. 使用 APIRouter 在 routes.py 中定义新的路由处理程序：

   @router.get("/new-route")
   async def new_route():
       return {"message": "This is a new route"}
   

2. 使用路由器定义的所有路由将自动包含在主应用程序中

自定义 MCP 集成

MCP SSE 功能通过以下方式集成在 server.py 中：

• 创建 SSE 传输
• 设置 SSE 处理程序
• 将 MCP 路由添加到 FastAPI 应用程序

与 Continue 集成

要将此 MCP 服务器与 Continue VS Code 扩展一起使用，请将以下配置添加到您的 Continue 设置：

{
  "experimental": {
    "modelContextProtocolServers": [
      {
        "transport": {
          "name": "weather",
          "type": "sse",
          "url": "http://localhost:8000/sse"
        }
      }
    ]
  }
}