Supergateway Zi4

🚀 SuperGateway

SuperGateway 是一個強大的網關工具，它能將標準輸入/輸出（stdio）轉換為服務器發送事件（SSE）。藉助該工具，你可以運行基於 stdio 的 MCP（模型上下文協議）服務器，並通過 SSE 實現遠程訪問，為你的應用帶來更便捷的交互體驗。

🚀 快速開始

SuperGateway 能輕鬆將基於 stdio 的 MCP 服務器轉換為 SSE 服務，支持多客戶端同時連接，還具備自動識別和轉發 JSON 格式輸出等功能。以下為你介紹其使用步驟。

✨ 主要特性

• 🔄 將基於 stdio 的 MCP 服務器轉換為 SSE 服務
• 👥 支持多個客戶端同時連接
• 📄 自動識別和轉發 JSON 格式的輸出
• 🌐 支持跨域請求（CORS）
• 💪 支持健康檢查端點
• 📝 可配置的日誌級別

📦 安裝指南

系統要求

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

構建和運行

1. 構建項目：

cd src/java
mvn clean package

2. 運行應用：

java -jar target/supergateway-1.0.0.jar [選項]

💻 使用示例

基礎用法

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

📚 詳細文檔

命令行選項

• --version: 顯示版本號
• --stdio: 要運行的 MCP 服務器命令
• --sse: SSE URL 連接地址
• --port: (stdio→SSE) 服務器監聽端口 [默認: 8000]
• --baseUrl: (stdio→SSE) SSE 客戶端的基礎 URL
• --ssePath: (stdio→SSE) SSE 訂閱路徑 [默認: "/sse"]
• --messagePath: (stdio→SSE) SSE 消息路徑 [默認: "/message"]
• --logLevel: 設置日誌級別: "info" 或 "none" [默認: "info"]
• --cors: 啟用 CORS [默認: false]
• --healthEndpoint: 添加健康檢查端點，多個端點用逗號分隔
• --help: 顯示幫助信息

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"

⚠️ 注意事項

⚠️ 重要提示

1. 進程輸出必須是 JSON 格式才會被轉發到 SSE 客戶端
2. 每個 SSE 客戶端會自動獲得一個唯一的 sessionId
3. 所有消息都必須是有效的 JSON 格式
4. 發送消息時必須使用從 SSE 連接獲取的正確 sessionId
5. MCP 服務器必須支持通過標準輸入/輸出進行通信