Supergateway 安装与配置指南

1. 项目基础介绍

Supergateway 是一个开源项目，它能够将基于标准输入/输出（stdio）的 MCP（Model Context Protocol）服务器转换为服务器发送事件（SSE）或 WebSocket 服务。这样的转换简化了与网页或远程客户端的集成和调试过程。该项目主要用于远程访问、调试以及连接仅支持 stdio 的 MCP 服务器。

该项目主要使用 TypeScript 编写，同时包含了 JavaScript、Shell 和 Dockerfile 等语言。

2. 关键技术与框架

• Model Context Protocol (MCP): 一种标准化 AI 工具交互的协议。
• 服务器发送事件 (Server-Sent Events, SSE): 一种仅服务器到客户端单向通信的技术，允许服务器推送数据到浏览器。
• WebSocket: 一种提供全双工通信通道的协议，允许服务器和客户端之间实时双向通信。
• Node.js: 作为运行环境，用于执行 JavaScript 代码。
• Docker: 容器化技术，用于打包和运行应用。

3. 安装和配置

准备工作

在开始安装之前，请确保您的系统中已经安装以下软件：

• Node.js (推荐版本 LTS)
• Docker (如果需要使用 Docker 镜像)

安装步骤

使用 npm 安装

1. 克隆项目到本地：

   git clone https://github.com/supercorp-ai/supergateway.git
   cd supergateway
   

2. 安装依赖：

   npm install
   

3. 运行 Supergateway：

   npx supergateway --stdio "your-mcp-server-command"
   

   将 your-mcp-server-command 替换为你的 MCP 服务器启动命令。

使用 Docker 安装

1. 获取 Supergateway 镜像：

   docker pull supercorp/supergateway
   

2. 运行 Docker 容器：

   docker run -it --rm -p 8000:8000 supercorp/supergateway --stdio "your-mcp-server-command"
   

   同样，将 your-mcp-server-command 替换为你的 MCP 服务器启动命令。

配置指南

• 端口配置：通过 --port 选项可以指定 Supergateway 监听的端口。
• 输出传输配置：通过 --outputTransport 选项可以设置 MCP 传输方式为 stdio、sse 或 ws。
• 消息路径配置：通过 --messagePath 选项可以设置消息的路径，默认为 /message。
• SSE 路径配置：通过 --ssePath 选项可以设置 SSE 订阅的路径，默认为 /sse。
• 日志级别配置：通过 --logLevel 选项可以设置日志级别为 info 或 none。

以上是 Supergateway 的基础安装和配置指南。请根据您的具体需求调整配置参数，并确保在运行前已经正确安装了所有必要的依赖。