OpenAPI MCP Server

OpenAPI MCP Server

site icon
2025.03.30 0
JavaScriptAPI 转换AI 工具集成开发效率
waha-api-mcp-server 是一个基于 OpenAPI 规范的 Model Context Protocol (MCP) 服务器,其主要功能是将 OpenAPI 规范文件中的每个 API 操作转换为 Claude AI 可使用的工具。该服务器能够自动解析 OpenAPI YAML 文件,生成对应的 MCP 工具,并处理路径参数、查询参数和请求体。当 Claude 使用这些工具时,服务器会实时调用相应的 API 并将结果返回给 Claude。
View on GitHub

Overview

基本能力

产品定位

waha-api-mcp-server 是一个用于将 OpenAPI 规范转换为 Claude AI 可使用的工具的服务,旨在提升开发效率和 AI 工具的集成能力。

核心功能

  • 自动解析 OpenAPI YAML 文件
  • 为每个 API 操作生成 MCP 工具
  • 处理路径参数、查询参数和请求体
  • 实时调用 API 并返回结果给 Claude
  • 与 Claude Desktop 轻松集成

适用场景

  • 开发人员需要将现有 API 快速集成到 Claude AI 中
  • 需要自动化 API 调用和分析的场景
  • 提升 AI 工具与后端服务的交互能力

工具列表

  • 每个 OpenAPI 规范中的 API 操作都会生成一个对应的工具,工具的能力包括:
  • 调用指定的 API 端点
  • 处理各种参数类型
  • 返回 API 响应数据

常见问题解答

  • 如何指定 OpenAPI 文件路径? 通过环境变量 OPENAPI_FILE 指定路径,默认为 ./openapi.yaml
  • 如何启用调试日志? 设置环境变量 DEBUG=true

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm
  2. 克隆仓库并安装依赖:
git clone https://github.com/yourusername/openapi-mcp-server.git
cd openapi-mcp-server
npm install

安装教程

  1. 将 OpenAPI YAML 文件放在项目目录中或通过环境变量指定路径
  2. 可选设置环境变量:
echo "DEBUG=true" > .env
echo "OPENAPI_FILE=./path/to/your/openapi.yaml" >> .env
  1. 初始化服务器(与 Claude Desktop 集成):
npm run init
  1. 或手动运行服务器:
npm start

调试方式

  1. 确保已设置 DEBUG=true 环境变量
  2. 启动服务器后,观察控制台日志输出
  3. 通过 Claude 调用工具时,服务器会显示详细的请求和响应信息

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。