mcp-server-yapi

MCP Server YAPI 是一个专为 YApi 设计的 MCP 服务器。它将 YApi 的常用功能封装成一系列工具，使大型语言模型（LLMs）能够通过自然语言与您的 YApi 平台进行交互，实现接口管理自动化。

✨ 核心功能

通过此服务，您可以使用自然语言完成以下操作：

• 项目管理获取基本项目信息。
• 接口管理创建、保存、更新和检索接口信息。
• 接口分类创建类别并获取类别菜单。
• 数据导入导入接口数据。
• 接口列表检索项目或类别下的接口列表。

⚙️ 客户端配置

安装要求

• Node.js >= v18.0.0
• 支持 MCP 协议的客户端，如 Cursor、Windsurf、Claude Desktop 等

配置示例

YAPI 的项目令牌：在“项目 -> 设置 -> 令牌配置”

{
  "mcpServers": {
    "mcp-server-yapi": {
      "command": "npx",
      "args": ["-y", "mcp-server-yapi"],
      "env": {
        "YAPI_BASE_URL": "YAPI服务地址，例如：https://xxx.yyy.com",
        "YAPI_TOKEN": "项目TOKEN",
        "MCP_DEBUG_CONSOLE": "false"
      }
    }
  }
}

🔧 本地开发和调试

请确保在您的开发环境中已安装 Node.js（版本 >=18）。

1. 克隆并编译

# 克隆仓库
git clone https://github.com/kales0202/mcp-server-yapi.git

# 进入项目目录
cd mcp-server-yapi

# 安装依赖
npm install

# 编译生成 dist/index.js
npm run build

2. 结合 AI 代理

您可以将此服务集成到支持 MCP 协议的 AI 代理客户端中，并在客户端配置文件中添加以下配置

YAPI 的项目 TOKEN：在“项目 -> 设置 -> 令牌配置”

{
  "mcpServers": {
    "mcp-server-yapi": {
      "command": "node",
      "args": ["/绝对路径/到你的/mcp-server-yapi/dist/index.js"],
      "env": {
        "YAPI_BASE_URL": "YAPI服务地址",
        "YAPI_TOKEN": "项目TOKEN",
        "MCP_DEBUG_CONSOLE": "false"
      }
    }
  }
}

🛠️ 可用工具列表

• get_project: 获取基本项目信息
• add_cat: 添加接口分类
• get_cat_menu: 获取菜单列表
• list_cat检索特定类别的接口列表
• list_menu: 获取接口菜单列表
• get_interface: 获取接口数据
• list_interface: 检索接口列表数据
• save_interface添加或更新接口
• add_interface: 添加接口
• up_interface更新接口
• import_data服务器数据导入