用途:查询与同步 YApi 接口文档,适合在编辑器或 AI 编程环境中按接口 URL、HTTP 路径或产品关键词定位接口定义,查看请求/响应详情,并把本地文档推送到 YApi。
安装:npx skills add leeguooooo/cross-request-master -y -g;也可用 npm install -g @leeguoo/yapi-mcp@0.6.1 后执行 yapi install-skill --force。若未全局安装,可用 npx -y -p @leeguoo/yapi-mcp@0.6.1 yapi 代替 yapi 命令。
认证:读取 ~/.yapi/config.toml 中的 base_url,缺失时执行 yapi login --base-url=https://your-yapi-domain.com --browser,登录后按回车同步 cookie,用 yapi whoami 校验。
主要能力:
- 按 YApi 页面 URL 提取 project_id/api_id 直接查询,如 yapi interface get --id 456。
- 按 HTTP 路径查找接口,需提供 --project-id,如 yapi interface list-menu --project-id 365 --path /api/auth/token --method POST;文档说明 yapi search 不索引路径,不要用它查路径。
- 关键词模糊搜索,并用中英文近义词扩展重试,如 yapi search --q "语音房列表"、room list、voice room。
- 浏览分组、项目、分类、成员、环境,导出 Swagger,管理测试集合。
- 文档同步:先 yapi docs-sync bind add 建立绑定,用 --dry-run 预览,再执行同步。默认只同步变动文件,--force 全量。绑定文件为 .yapi/docs-sync.json,映射输出 docs-sync.links.json 等。
限制:HTML 源文件需自包含(内联 CSS、base64 或 CDN 图片),相对路径不会被重写;HTML 不做 XSS 过滤,iframe 仅 allow-same-origin,脚本不会执行,高度固定 1500px。目录中同名的 .md 与 .html 同时存在时优先用 .html 并告警。上传若遇 413 会先用 --mermaid-classic 重试,仍失败需拆分文档。Mermaid 等渲染依赖本机工具,缺失不影响基础同步。0.6.0 升级到 0.6.1 后建议执行一次 yapi docs-sync --force。创建或更新接口时应设置 req_body_type 并提供 res_body。