前言

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

主要用于常见的AI编程客户端(如Cursor)访问Yapi服务。

使用

在项目根目录创建 .cursor/mcp.json

内容如下

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

提供的工具

| 工具名 | 说明 | | ---------------------------- | -------------------------------------------------------------------------------------- | | 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的详情