Supergateway

🚀 Super Gateway 日本語ドキュメント

Super Gateway は、MCP 標準入力サーバーを SSE（Server-Sent Events）または WebSocket サービスに変換し、Web ページやリモートクライアントとの統合およびデバッグを簡素化します。これにより、任意の 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

✨ 主な機能

• 2 つの動作モードをサポート：

  • 標準入力 -> SSE
  • 標準入力 -> WebSocket

• モジュール化設計：

  • JSON-RPC バージョンを自動管理
  • 可能な場合はパケットメタデータを再送信
  • 標準入力 -> SSE または標準入力 -> WebSocket モードでは標準出力を介してログを記録
  • 標準出力 -> 標準入力 モードでは標準エラーを介してログを記録

📦 インストール

npm パッケージマネージャーを使用したインストール

npm install -g supergateway

📚 ドキュメント

設定オプション

以下は Super Gateway の完全な設定パラメータです。

• port: リッスンするポート。デフォルト値は 8000。
• mode: 動作モード。'ssea' または 'ws' を選択できます。
• input: 標準入力ストリーム（デフォルトは process.stdin）。
• output: 標準出力ストリーム（デフォルトは process.stdout）。
• onError: エラー処理コールバック関数。

💻 使用例

基本的な使用法

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,
});

🤝 貢献者

• 张三
• 李四

📄 ライセンス

このプロジェクトは MIT ライセンスの下で公開されています。詳細は LICENSE ファイルを参照してください。

Super Gateway をご利用いただき、ありがとうございます！ さらなるヘルプが必要な場合は、GitHub リポジトリを参照してください。