Supergateway Zi4

🚀 SuperGateway

SuperGateway is a gateway tool that converts standard input/output (stdio) to Server-Sent Events (SSE). It enables you to run an stdio-based MCP (Model Context Protocol) server and access it remotely via SSE.

🚀 Quick Start

SuperGateway is a powerful tool that bridges the gap between stdio-based MCP servers and SSE clients. It allows for seamless remote access to MCP servers through SSE, enhancing the flexibility and accessibility of your applications.

✨ Features

• Convert an stdio-based MCP server to an SSE service.
• Support multiple client connections simultaneously.
• Automatically recognize and forward JSON-formatted output.
• Support Cross-Origin Resource Sharing (CORS).
• Provide a health check endpoint.
• Offer configurable logging levels.

📦 Installation

System Requirements

• Java 17 or higher.
• Maven 3.6 or higher.

Build and Run

1. Build the project:

cd src/java
mvn clean package

2. Run the application:

java -jar target/supergateway-1.0.0.jar [options]

Command-line Options

• --version: Display the version number.
• --stdio: The command to run the MCP server.
• --sse: The SSE URL connection address.
• --port: The port on which the (stdio→SSE) server listens [Default: 8000].
• --baseUrl: The base URL for the SSE client of the (stdio→SSE) server.
• --ssePath: The SSE subscription path of the (stdio→SSE) server [Default: "/sse"].
• --messagePath: The SSE message path of the (stdio→SSE) server [Default: "/message"].
• --logLevel: Set the logging level: "info" or "none" [Default: "info"].
• --cors: Enable CORS [Default: false].
• --healthEndpoint: Add health check endpoints, separated by commas.
• --help: Display help information.

💻 Usage Examples

Basic Usage

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

📚 Documentation

API Interfaces

1. SSE Connection

• URL: GET /sse
• Description: Establish an SSE connection to receive process output.
• Response: The server will return an SSE event containing the message sending endpoint.

2. Send a Message

• URL: POST /message?sessionId=<session_id>
• Content-Type: application/json
• Description: Send a JSON-formatted message to the process.
• Response:
  • 200: Message sent successfully.
  • 400: Invalid JSON message.
  • 503: Session does not exist or the process is not ready.

3. Health Check

• URL: GET /health (if the health check endpoint is configured)
• Description: Check if the service is running normally.
• Response: Returns "ok".

⚠️ Important Note

1. Process output must be in JSON format to be forwarded to SSE clients.
2. Each SSE client will automatically receive a unique sessionId.
3. All messages must be in valid JSON format.
4. When sending a message, you must use the correct sessionId obtained from the SSE connection.
5. The MCP server must support communication via standard input/output.