z-yapi-mcp 运行说明

这是一个基于 @modelcontextprotocol/sdk 实现的 MCP stdio 服务，通过调用 YApi 接口提供工具能力。

环境准备

• Node.js：建议 20+ 版本
• 操作系统：Windows / macOS / Linux 均可

安装依赖

在项目根目录执行：

cd d:\Project\ai\z-yapi-mcp
npm install

使用

{
  "mcpServers": {
    "z-yapi-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "z-yapi-mcp",
        "--stdio",
        "--yapi-base-url=your_yapi_url",
        "--yapi-token=your_yapi_token",
        "--yapi-project-id=your_yapi_project_id"
      ]
    }
  }
}

本地测试脚本

仓库中提供了一个简单的本地测试脚本 test-tools-list.mjs，可以在不依赖外部 MCP 客户端的前提下验证服务是否正常返回工具列表。

先构建：

cd d:\Project\ai\z-yapi-mcp
npm run build

然后执行测试脚本：

cd d:\Project\ai\z-yapi-mcp
node .\test-tools-list.mjs

如果终端中可以看到 tools/list 返回的工具信息（包含 yapi_get_interface、yapi_list_interface_menu、yapi_list_interface、yapi_list_interface_by_cat），则说明服务工作正常。

提供的工具

| 工具名 | 说明 | |--------|------| | yapi_get_interface | 根据接口 ID 获取接口详情 | | yapi_list_interface_menu | 获取接口菜单列表（使用启动参数中的项目 ID，无需传参） | | yapi_list_interface | 获取接口列表数据（使用启动参数中的项目 ID，固定第 1 页、每页 1000 条，无需传参） | | yapi_list_interface_by_cat | 获取某个分类下的接口列表（传入分类 ID catid，固定第 1 页、每页 1000 条，不传分页参数） |

使用示例

使用MCP 获取项目下有多少接口

使用MCP 获取项目的分类信息

使用MCP 获取分类XX下的接口

使用MCP 获取分类ID为XX下的接口

使用MCP 获取接口ID为XX的详情