OpenAPI转换工具

Relay是一个将OpenAPI/Swagger规范转换为AI可调用的MCP工具的服务,作为AI助手和REST API之间的桥梁,自动从API文档生成工具并执行真实的HTTP请求。

  • by Algovate
  • TypeScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 Algovate/relay-mcp

使用说明

接力

通用OpenAPI ➜ 带有企业认证的MCP中继服务器。

什么是中继?

Relay将任何OpenAPI/Swagger规范转换为AI可调用的MCP工具。它作为AI助手和REST API之间的桥梁,自动从API文档中生成工具并执行真实的HTTP请求。

主要功能将任何REST API转换为AI助手可以直接使用的MCP工具。

安装

npm install relay-mcp

基本用法

  1. 安装并构建:
npm install
npm run build
  1. 配置 (创建 .env 文件):
SWAGGER_SOURCE=url
SWAGGER_URL=https://petstore.swagger.io/v2/swagger.json
AUTH_TYPE=none
  1. 运行服务器:
npm start
  1. 添加到MCP客户端 (例如,用于标准输入输出的Claude Desktop)
{
  "mcpServers": {
    "relay": {
      "command": "node",
      "args": ["/path/to/relay/dist/index.js"],
      "env": {
        "SWAGGER_SOURCE": "url",
        "SWAGGER_URL": "https://petstore.swagger.io/v2/swagger.json",
        "AUTH_TYPE": "none",
        "TRANSPORT": "stdio"
      }
    }
  }
}

或者作为独立服务器运行,使用SSE/HTTP:

# For SSE transport
TRANSPORT=sse TRANSPORT_PORT=3000 npm start

# For HTTP transport
TRANSPORT=http TRANSPORT_PORT=3000 npm start

然后配置您的MCP客户端以连接到 http://localhost:3000/mcp。

特点/特性

  • 从任意OpenAPI/Swagger规范生成动态工具
  • 使用拦截器和结构化日志记录的实时HTTP执行
  • 认证:API密钥(头部/查询)、承载令牌、基本认证
  • 支持OpenAPI 2.0和3.x版本
  • 多种传输模式:stdio(标准输入输出)、SSE(服务器发送事件)、HTTP

文档

  • 📚 书籍或阅读的象征 文档中心 - 完整的文档索引
  • 🚀 表情符号“🚀”在中文中通常直接保留原样,不进行翻译,因为它是一个通用的表情符号,代表火箭、快速前进或加速等概念。所以,翻译结果就是“🚀”。 快速入门指南 - 快速起床并开始行动
  • 🔧(扳手/修理工具的符号,常用于表示需要修理或维护的物品或情况) 安装说明 - 详细配置
  • 📋 表格/清单 更新日志 - 版本历史和更新

链接

许可证

麻省理工学院(MIT)