Supergateway

🚀 Super Gateway

Super Gateway transforms MCP standard input servers into SSE (Server-Sent Events) or WebSocket services, simplifying integration and debugging with web pages or remote clients. It enables you to easily expose any MCP standard input server as a modern network protocol interface.

✨ Features

• Two operating modes supported:

  • Standard input -> SSE
  • Standard input -> WebSocket

• Modular design:

  • Automatically manages JSON-RPC versions.
  • Re-transmits packet metadata whenever possible.
  • Logs in standard input -> SSE or standard input -> WebSocket mode via standard output.
  • Logs in standard output -> standard input mode via standard error.

📦 Installation

Install using the npm package manager

npm install -g supergateway

🚀 Quick Start

Create an MCP server

Create a simple MCP server:

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

createServer((req, res) => {
  // Handle request logic
}).listen(8000);

// Initialize the Super Gateway service
const superGateway = new Server({
  input: process.stdin,
  output: process.stdout,
  onError: (error) => console.error('Super Gateway error:', error),
});

Run the example

Run the MCP server:

node index.js

📚 Documentation

The following are the complete configuration parameters for Super Gateway:

• port: The port to listen on, with a default value of 8000.
• mode: The operating mode, with optional values of 'ssea' or 'ws'.
• input: The standard input stream (default is process.stdin).
• output: The standard output stream (default is process.stdout).
• onError: The error handling callback function.

💻 Usage Examples

Use Super Gateway to create an SSE service

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

createServer((req, res) => {
  if (req.url === '/api') {
    // Send real-time updates
    setInterval(() => {
      res.write(`data: ${new Date().toISOString()}\n\n`);
    }, 1000);
  }
}).listen(8000);

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

Use Super Gateway to create a WebSocket service

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

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

wss.on('connection', (ws) => {
  // Handle WebSocket connection logic
});

server.listen(8000);

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

🤝 Contributors

• Zhang San
• Li Si

📄 License

This project is licensed under the MIT license. For details, see the LICENSE file.

Thank you for using Super Gateway! For more help, please refer to our GitHub repository.