内容
# Starlette MCP SSE
<p align="center">
<strong>English</strong> | <a href="/README.zh-CN.md">简体中文</a>
</p>
一个使用 Starlette 框架并集成 [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) 的服务器推送事件 (SSE) 实现。
## 什么是 MCP？
[Model Context Protocol (MCP)](https://modelcontextprotocol.io/) 是一个开放标准，使 AI 模型能够与外部工具和数据源进行交互。MCP 解决了 AI 开发中的几个关键挑战：
- **上下文限制**：允许模型访问超出其训练数据的最新信息
- **工具集成**：为模型使用外部工具和 API 提供标准化的方法
- **互操作性**：在不同的 AI 模型和工具之间创建一个通用接口
- **可扩展性**：使得在不重新训练的情况下，轻松添加新功能到 AI 系统中
该项目演示了如何在 Starlette Web 应用程序中使用服务器推送事件 (SSE) 实现 MCP。
## 描述
该项目演示了如何使用 Starlette 框架实现服务器推送事件 (SSE)，同时集成 Model Context Protocol (MCP) 功能。其关键特性是将 MCP 的 SSE 功能无缝集成到一个包含自定义路由的全功能 Starlette Web 应用程序中。
## 特性
- 带有 MCP 的服务器推送事件 (SSE) 实现
- 与自定义路由的 Starlette 框架集成
- 统一的 Web 应用程序，包含 MCP 和标准 Web 端点
- 可定制的路由结构
- 在 MCP 和 Web 功能之间实现清晰的关注点分离
## 架构
该项目展示了一个模块化架构：
1. 将 MCP SSE 端点 (`/sse` 和 `/messages/`) 集成到 Starlette 应用程序中
2. 提供标准 Web 路由 (`/`, `/about`, `/status`, `/docs`)
3. 演示如何保持 MCP 功能与 Web 路由之间的分离
## 安装与使用选项
### 先决条件
安装 [UV Package Manager](https://docs.astral.sh/uv/) - 一个用 Rust 编写的快速 Python 包安装器：
```cmd
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```
### 选项 1：无需安装的快速运行
使用 UV 的执行工具直接运行应用程序，而无需克隆仓库：
```cmd
uvx --from git+https://github.com/panz2018/starlette_mcp_sse.git start
```
### 选项 2：完整安装
#### 创建虚拟环境
为项目创建一个隔离的 Python 环境：
```cmd
uv venv
```
#### 激活虚拟环境
激活虚拟环境以使用它：
```cmd
.venv\Scripts\activate
```
#### 安装依赖
安装所有所需的包：
```cmd
uv pip install -r pyproject.toml
```
#### 启动集成服务器
启动集成的 Starlette 服务器，带有 MCP SSE 功能：
```cmd
python src/server.py
```
或
```cmd
uv run start
```
### 可用端点
启动服务器后（使用选项 1 或选项 2），将提供以下端点：
- 主服务器： http://localhost:8000
- 标准 Web 路由：
- 首页： http://localhost:8000/
- 关于页面： http://localhost:8000/about
- 状态 API： http://localhost:8000/status
- 文档： http://localhost:8000/docs
- MCP SSE 端点：
- SSE 端点： http://localhost:8000/sse
- 消息发布： http://localhost:8000/messages/
### 使用 MCP Inspector 调试
要测试和调试 MCP 功能，请使用 MCP Inspector：
```cmd
mcp dev ./src/weather.py
```
### 连接到 MCP Inspector
1. 打开 MCP Inspector，地址为 http://localhost:5173
2. 配置连接：
- 将传输类型设置为 `SSE`
- 输入 URL： http://localhost:8000/sse
- 点击 `Connect`
### 测试功能
1. 导航到 `Tools` 部分
2. 点击 `List Tools` 查看可用功能：
- `get_alerts` : 获取天气警报
- `get_forcast` : 获取天气预报
3. 选择一个功能
4. 输入所需参数
5. 点击 `Run Tool` 执行
## 扩展应用程序
### 添加自定义路由
应用程序结构使得添加新路由变得简单：
1. 在 routes.py 中定义新的路由处理程序
2. 将路由添加到 routes.py 中的路由列表
3. 主应用程序将自动包含这些路由
### 自定义 MCP 集成
MCP SSE 功能通过以下方式集成到 server.py 中：
- 创建一个 SSE 传输
- 设置一个 SSE 处理程序
- 将 MCP 路由添加到 Starlette 应用程序中
## 与 [Continue](https://www.continue.dev/) 的集成
要将此 MCP 服务器与 Continue VS Code 扩展一起使用，请将以下配置添加到您的 Continue 设置中：
```json
{
"experimental": {
"modelContextProtocolServers": [
{
"transport": {
"name": "weather",
"type": "sse",
"url": "http://localhost:8000/sse"
}
}
]
}
}
```
MCP 市场