supergateway:轻松实现MCP服务器与SSE和WS的连接
supergateway:轻松实现MCP服务器与SSE和WS的连接
supergateway Run MCP stdio servers over SSE and SSE over stdio. AI gateway. 项目地址: https://gitcode.com/gh_mirrors/su/supergateway
项目介绍
supergateway 是一个开源项目,它能够通过简单的命令行操作,将基于 stdio 的 MCP(Model Context Protocol)服务器运行在 SSE(Server-Sent Events)或 WebSockets(WS)上。这对于远程访问、调试或连接只支持 stdio 的 MCP 服务器与客户端来说非常有用。supergateway 由 Supercorp 支持,并且与 Supermachine 和 Superinterface 兼容。
项目技术分析
supergateway 的核心在于它能够将传统的 MCP stdio 服务器转换为现代的网络协议,如 SSE 或 WS。这种转换不仅增加了服务器的可用性和灵活性,还使其能够更好地与 web-based 或远程客户端集成。以下是该项目的关键技术特点:
- 命令行操作:supergateway 提供了一个简洁的命令行界面,用户可以通过简单的命令启动服务器,并指定运行参数。
- 协议转换:项目支持从 stdio 到 SSE 或 WS 的转换,允许用户根据需求选择最适合的通信协议。
- 高度配置性:supergateway 允许用户自定义端口、基URL、日志级别、CORS 设置等,以满足不同的部署需求。
项目及技术应用场景
supergateway 的应用场景广泛,以下是一些典型的使用案例:
- 远程访问:当 MCP 服务器位于远程位置时,supergateway 可以帮助用户在本地环境中访问和调试服务器。
- Web集成:通过将 MCP 服务器转换为 SSE 或 WS,开发人员可以更容易地将 AI 工具集成到 web 应用程序中。
- 调试工具:supergateway 提供了与 MCP Inspector 的集成,帮助开发人员快速检查和测试 MCP 服务器的状态和功能。
项目特点
以下是 supergateway 的一些主要特点:
- 简便性:通过简单的命令行操作即可启动服务器,无需复杂的配置。
- 兼容性:与 Supermachine、Superinterface 和 Supercorp 兼容,支持多种部署环境。
- 灵活性:支持多种通信协议,用户可以根据具体情况选择最适合的协议。
- 高度可配置:提供了丰富的配置选项,满足不同用户的需求。
以下是具体的安装和使用说明:
安装与使用
安装 supergateway 非常简单,用户可以使用 npx
命令来运行它:
npx -y supergateway --stdio "uvx mcp-server-git"
在这个命令中,--stdio "uvx mcp-server-git"
指定了要运行的 MCP 服务器命令。用户还可以指定输出传输协议(如 sse
或 ws
),监听端口,以及基URL等。
stdio → SSE 模式
要将 MCP stdio 服务器作为 SSE 服务器公开,可以使用以下命令:
npx -y supergateway
--stdio "npx -y @modelcontextprotocol/server-filesystem ./my-folder"
--port 8000 --baseUrl http://localhost:8000
--ssePath /sse --messagePath /message
用户可以通过发送 GET 请求到 /sse
路径来订阅事件,或者通过发送 POST 请求到 /message
路径来发送消息。
SSE → stdio 模式
若要连接到远程 SSE 服务器并在本地环境中公开,可以使用以下命令:
npx -y supergateway --sse "https://mcp-server-ab71a6b2-cd55-49d0-adba-562bc85956e3.supermachine.app"
stdio → WS 模式
若要将 MCP stdio 服务器作为 WebSocket 服务器公开,可以使用以下命令:
npx -y supergateway
--stdio "npx -y @modelcontextprotocol/server-filesystem ./my-folder"
--port 8000 --outputTransport ws --messagePath /message
WebSocket 客户端可以连接到 ws://localhost:8000/message
端点。
高级配置
supergateway 还支持一些高级配置,如自动管理 JSON-RPC 版本、重传包元数据等。这些配置使得项目更加灵活和强大,能够满足不同用户的需求。
supergateway 是一个功能强大的开源项目,它简化了 MCP 服务器的部署和使用,为开发人员提供了一个高效、灵活的工具。无论是远程访问、Web 集成还是调试工具,supergateway 都能够提供出色的支持。如果您正在寻找一种更简单的方式来实现 MCP 服务器的网络通信,那么 supergateway 可能正是您需要的解决方案。
supergateway Run MCP stdio servers over SSE and SSE over stdio. AI gateway. 项目地址: https://gitcode.com/gh_mirrors/su/supergateway