Supergateway

🚀 Super Gateway 中文文檔

Super Gateway 可將 MCP 標準輸入服務器轉換為 SSE（Server-Sent Events）或 WebSocket 服務，極大簡化了與網頁或遠程客戶端的集成與調試工作。藉助 Super Gateway，您能輕鬆地將任意 MCP 標準輸入服務器以現代網絡協議接口的形式對外暴露。

🚀 快速開始

創建 MCP 服務器

創建一個簡單的 MCP 服務器：

import { createServer } from 'http';
import { Server } from 'supergateway';

createServer((req, res) => {
  // 處理請求邏輯
}).listen(8000);

// 初始化 Super Gateway 服務
const superGateway = new Server({
  input: process.stdin,
  output: process.stdout,
  onError: (error) => console.error('Super Gateway 錯誤:', error),
});

運行示例

運行 MCP 服務器：

node index.js

✨ 主要特性

• 支持兩種運行模式：
  • 標準輸入 -> SSE
  • 標準輸入 -> WebSocket
• 模塊化設計：
  • 自動管理 JSON - RPC 版本
  • 在可能的情況下重新傳輸包元數據
  • 標準輸入 -> SSE 或標準輸入 -> WebSocket 模式通過標準輸出進行日誌記錄
  • 標準輸出 -> 標準輸入 模式通過標準錯誤進行日誌記錄

📦 安裝指南

使用 npm 包管理器安裝

npm install -g supergateway

💻 使用示例

基礎用法

使用 Super Gateway 創建 SSE 服務

import { createServer } from 'http';
import { Server } from 'supergateway';

createServer((req, res) => {
  if (req.url === '/api') {
    // 發送即時更新
    setInterval(() => {
      res.write(`data: ${new Date().toISOString()}\n\n`);
    }, 1000);
  }
}).listen(8000);

const superGateway = new Server({
  input: process.stdin,
  output: process.stdout,
});

使用 Super Gateway 創建 WebSocket 服務

import { createServer } from 'http';
import { WebSocketServer } from 'ws';
import { Server } from 'supergateway';

const server = createServer();
const wss = new WebSocketServer(server);

wss.on('connection', (ws) => {
  // 處理 WebSocket 連接邏輯
});

server.listen(8000);

const superGateway = new Server({
  input: process.stdin,
  output: process.stdout,
});

📚 詳細文檔

以下是 Super Gateway 的完整配置參數：

🤝 貢獻者

• 張三
• 李四

📄 許可證

項目採用 MIT 許可證，詳見 LICENSE 文件。

感謝您使用 Super Gateway！如需更多幫助，請參考我們的 GitHub 倉庫。