MCP Gateway 236

🚀 MCP Gateway

The MCP Gateway is a reverse proxy server that forwards client requests to MCP servers or enables the use of multiple MCP servers through a unified entry point.

✨ Features

• Deploy multiple MCP servers.
• Connect to MCP servers.
• Invoke MCP servers via the gateway.
• Retrieve SSE streams from all MCP servers.
• Obtain tools from all MCP servers.

⚠️ Important Note

Currently, STDIO has shifted to the Super Gateway (open - sourced by supercorp - ai), and we will implement this feature independently in the future.

📦 Installation

1. Pull the image package from GitHub:

docker pull ghcr.io/lucky-aeon/mcp-gateway:latest

2. Build the Docker image yourself:

docker build -t mcp-gateway .

💻 Usage Examples

Basic Usage

Run the Docker container provided by GitHub:

docker run -d --name mcp-gateway -p 8080:8080 ghcr.io/lucky-aeon/mcp-gateway

Run the self - built Docker image:

docker run -d --name mcp-gateway -p 8080:8080 mcp-gateway

📚 Documentation

Deploy MCP Servers

Supported Content Types:

• application/json
• multipart/form-data
• x-www-form-urlencoded

Request Path: POST /api/deploy

Request Body Example:

{
  "mcpServers": {
    "server1": {
      "url": "http://example.com/mcp",
      "command": "python3 mcp_server.py"
    },
    "server2": {
      "url": "http://another.example.com/mcp",
      "command": "java -jar mcp.jar"
    }
  }
}

Description:

• url and command are mutually exclusive fields, representing the URL address or startup command of the MCP server.
• Optional fields include args (an array for passing command - line parameters) and env (an object for setting environment variables).

Invoke MCP Servers

Get SSE Stream:

curl -X GET http://localhost:8080/api/mcp/sse

Invocation Method:

curl -X POST \
     -H "Content-Type: application/json" \
     -d '{"method": "timeConversion", "params": {"source_time": "12:00", "target_timezone": "Asia/Shanghai"}}' \
     http://localhost:8080/api/mcp/call

Gateway Functions

Unified Entry Point Invocation: All requests are forwarded to the corresponding MCP servers through the /api/mcp/* path, and cross - domain issues are automatically handled.

SSE Stream Processing: The gateway merges the SSE streams of multiple MCP servers and marks the source server name in the result.

Get Tool List

Request Path: GET /api/tools

Example Response:

{
  "tools": [
    {
      "name": "mcpServer1-timeConversion",
      "description": "Time conversion tool",
      "inputSchema": {
        "type": "object",
        "properties": {
          "source_time": {
            "type": "string",
            "description": "Source time, in the format of HH:MM"
          },
          "target_timezone": {
            "type": "string",
            "description": "Target timezone"
          }
        },
        "required": ["source_time", "target_timezone"]
      }
    },
    {
      "name": "mcpServer1-timeConvert",
      "description": "Time conversion tool",
      "inputSchema": {
        "type": "object",
        "properties": {
          "source_time": {
            "type": "string",
            "description": "Source time, in the format of HH:MM"
          },
          "target_timezone": {
            "type": "string",
            "description": "Target timezone"
          }
        },
        "required": ["source_time", "target_timezone"]
      }
    }
  ]
}

Description:

• The gateway automatically merges the tool lists of all MCP servers and marks the name of the MCP server to which each tool belongs in the result.
• The input schema defines the specific parameter requirements for each tool.

Notes

1. Error Handling:

   • The gateway performs legitimacy checks on requests and returns error information in a unified format.
   • Supported error codes include 400 (Invalid Request), 503 (Service Unavailable), etc.

2. Logging and Monitoring:

   • The gateway provides detailed access logs and health status monitoring.
   • You can view the running logs through /api/admin/logs.

3. Scalability:

   • It supports plug - in extensions, allowing users to add custom function modules as needed.
   • It provides rich configuration options, enabling users to customize the gateway behavior.