OpenAPI工具服务器

一个将OpenAPI规范文件转换为Claude AI可调用工具的服务器,支持自动解析YAML文件、生成API操作工具并实时处理API调用。

  • by gabfr
  • JavaScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 gabfr/waha-api-mcp-server

使用说明

OpenAPI MCP服务器

这是一个模型上下文协议(MCP)服务器,它读取OpenAPI规范文件,并将每个API操作公开为Claude AI使用的工具。

特性

  • 自动解析OpenAPI YAML文件
  • 为每个API操作生成MCP工具
  • 处理路径参数、查询参数和请求体
  • 在Claude使用这些工具时进行实时API调用
  • 与Claude Desktop轻松集成

安装

# Clone the repository
git clone https://github.com/yourusername/openapi-mcp-server.git
cd openapi-mcp-server

# Install dependencies
npm install

用法

  1. 将OpenAPI YAML文件放置在项目目录中,或通过环境变量提供其路径。

  2. 设置环境变量(可选):

# Create a .env file
echo "DEBUG=true" > .env
echo "OPENAPI_FILE=./path/to/your/openapi.yaml" >> .env
  1. 使用Claude Desktop初始化服务器:
npm run init
  1. 或者手动运行服务器:
npm start

配置

您可以使用环境变量配置服务器:

  • DEBUG:设置为 true 启用调试日志记录(默认值: false)
  • OPENAPI_FILE:OpenAPI YAML文件的路径(默认: ./openapi.yaml)

原理

服务器读取您的OpenAPI规范文件,然后:

  1. 提取所有路径和操作
  2. 为每个操作创建一个具有适当输入模式的工具
  3. 当Claude调用一个工具时,服务器会发出相应的API请求
  4. 响应返回给Claude进行分析

示例

OpenAPI规范如下:

paths:
  /users:
    get:
      operationId: listUsers
      summary: List all users
      ...

克劳德可以打电话给 listUsers 工具,服务器将向发出GET请求 /users 代表你。

许可证

麻省理工学院