Supergateway Zi4

🚀 SuperGateway

SuperGateway 是一个强大的网关工具，它能够将标准输入/输出（stdio）转换为服务器发送事件（SSE）。借助该工具，你可以运行基于 stdio 的 MCP（模型上下文协议）服务器，并通过 SSE 实现远程访问。

🚀 快速开始

SuperGateway 能让你轻松地将基于 stdio 的 MCP 服务器转换为 SSE 服务。以下是构建和运行该项目的步骤：

构建项目

cd src/java
mvn clean package

运行应用

java -jar target/supergateway-1.0.0.jar [选项]

✨ 主要特性

• 服务转换：将基于 stdio 的 MCP 服务器转换为 SSE 服务。
• 多客户端支持：支持多个客户端同时连接。
• 自动识别转发：自动识别和转发 JSON 格式的输出。
• 跨域请求支持：支持跨域请求（CORS）。
• 健康检查端点：支持健康检查端点。
• 日志级别可配置：可配置的日志级别。

📦 安装指南

系统要求

• Java 17 或更高版本
• Maven 3.6 或更高版本

💻 使用示例

基础用法

java -jar target/supergateway-1.0.0.jar \
  --stdio "java -jar your-mcp-server.jar" \
  --port 8000 \
  --baseUrl http://localhost:8000 \
  --ssePath /sse \
  --messagePath /message

📚 详细文档

命令行选项

API 接口

1. SSE 连接

• URL: GET /sse
• 说明：建立 SSE 连接以接收进程输出
• 响应：服务器会返回一个 SSE 事件，包含消息发送端点

2. 发送消息

• URL: POST /message?sessionId=<session_id>
• Content-Type: application/json
• 说明：向进程发送 JSON 格式的消息
• 响应：
  • 200: 消息发送成功
  • 400: 无效的 JSON 消息
  • 503: 会话不存在或进程未就绪

3. 健康检查

• URL: GET /health (如果配置了健康检查端点)
• 说明：检查服务是否正常运行
• 响应：返回 "ok"

⚠️ 重要提示

⚠️ 重要提示

• 进程输出必须是 JSON 格式才会被转发到 SSE 客户端。
• 每个 SSE 客户端会自动获得一个唯一的 sessionId。
• 所有消息都必须是有效的 JSON 格式。
• 发送消息时必须使用从 SSE 连接获取的正确 sessionId。
• MCP 服务器必须支持通过标准输入/输出进行通信。