Supergateway 开源项目教程

1. 项目介绍

Supergateway 是一个开源项目，它能够帮助用户将基于 stdio 的 MCP（Model Context Protocol）服务器转换为 SSE（Server-Sent Events）或 WebSocket 服务。这使得远程访问、调试或与仅支持 stdio 的 MCP 服务器进行客户端连接变得更为简单。该项目由 Supermachine、Superinterface 和 Supercorp 支持，适用于各种需要 MCP 服务器与 Web 或远程客户端交互的场景。

2. 项目快速启动

以下是如何快速启动 Supergateway 的步骤：

首先，确保您的系统中已安装 Node.js。然后，使用以下命令启动 Supergateway 服务：

npx -y supergateway --stdio "npx -y @modelcontextprotocol/server-filesystem ./my-folder" --port 8000 --baseUrl http://localhost:8000 --ssePath /sse --messagePath /message

这条命令将启动一个本地服务器，并将指定的 MCP 服务器暴露为 SSE 服务。

快速启动代码示例

# 启动 Supergateway 服务
npx -y supergateway --stdio "命令来启动您的 MCP 服务器" --port 8000

请替换 "命令来启动您的 MCP 服务器" 为实际的 MCP 服务器启动命令。

3. 应用案例和最佳实践

应用案例

• _stdio → SSE 模式：将本地的 MCP stdio 服务器暴露为 SSE 服务，使得 Web 客户端可以订阅并接收服务器发送的事件。
• SSE → stdio 模式：连接到一个远程的 SSE 服务器，并在本地通过 stdio 进行交互，适合在命令行环境中集成远程 MCP 服务器。
• _stdio → WS 模式：将本地的 MCP stdio 服务器暴露为 WebSocket 服务，提供实时双向通信的能力。

最佳实践

• 使用 --header 参数添加认证头信息，确保安全访问。
• 利用 --logLevel 参数控制日志输出，以适应不同的调试和生产环境需求。
• 通过 --healthEndpoint 注册健康检查端点，便于监控服务状态。

4. 典型生态项目

Supergateway 可以与以下生态项目配合使用，以提供更完整的功能和解决方案：

• ngrok：使用 ngrok 公开本地服务，实现远程访问。
• Docker：通过 Docker 容器运行 Supergateway，简化部署和运维流程。
• Claude Desktop：与 Claude Desktop 配合，使用 SSE → stdio 模式提供桌面端的 MCP 服务器交互。

以上就是 Supergateway 开源项目的教程，希望能帮助您更好地理解和使用这个项目。