Skip to content
Back to search

Yapi-MCP

yapi mcp server

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/lzsheng--yapi-mcp/badge.svg)](/listings/lzsheng--yapi-mcp)

HTML

<a href="/listings/lzsheng--yapi-mcp"><img src="/api/listings/lzsheng--yapi-mcp/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 251 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # Yapi Auto MCP Server
  2. 一个用于 YApi 的 Model Context Protocol (MCP) 服务器,让你能够在 Cursor 等 AI 编程工具中直接操作 YApi 接口文档。
  3. ## 项目简介
  4. Yapi Auto MCP Server 是一个基于 [Model Context Protocol](https://modelcontextprotocol.io/) 的服务器,专为 YApi 接口管理平台设计。它允许你在 Cursor、Claude Desktop 等支持 MCP 的 AI 工具中直接:
  5. - 🔍 **搜索和查看** YApi 项目中的接口文档
  6. - ✏️ **创建和更新** 接口定义
  7. - 📋 **管理项目和分类** 结构
  8. - 🔗 **无缝集成** AI 编程工作流
  9. - 🛠 **支持多个 YApi Project配置**
  10. 通过 MCP 协议,AI 助手可以理解你的 YApi 接口结构,在编程过程中提供更准确的建议和代码生成。
  11. ## 主要功能
  12. ### 🔍 接口查询和搜索
  13. - **yapi_search_apis**: 按名称、路径、标签等条件搜索接口
  14. - **yapi_get_api_desc**: 获取特定接口的详细信息(请求/响应结构、参数等)
  15. - **yapi_list_projects**: 列出所有可访问的项目
  16. - **yapi_get_categories**: 获取项目下的接口分类和接口列表
  17. ### ✏️ 接口管理
  18. - **yapi_save_api**: 创建新接口或更新现有接口
  19. - 支持完整的接口定义(路径、方法、参数、请求体、响应等)
  20. - 支持 JSON Schema 和表单数据格式
  21. - 自动处理接口状态和分类管理
  22. ### 🎯 智能特性
  23. - **多项目支持**: 同时管理多个 YApi 项目
  24. - **缓存机制**: 提高查询响应速度
  25. - **详细日志**: 便于调试和监控
  26. - **灵活配置**: 支持环境变量和命令行参数
  27. ## 快速开始
  28. ### 推荐方式:使用 npx(无需安装)
  29. 1. **获取 YApi Token**:登录你的 YApi 平台,在项目设置中获取 Token
  30. 2. **配置 Cursor**:在 Cursor 设置中添加 MCP 服务器:
  31. ```json
  32. {
  33. "mcpServers": {
  34. "yapi-auto-mcp": {
  35. "command": "npx",
  36. "args": [
  37. "-y",
  38. "yapi-auto-mcp",
  39. "--stdio",
  40. "--yapi-base-url=https://your-yapi-domain.com",
  41. "--yapi-token=projectId:your_token_here"
  42. ]
  43. }
  44. }
  45. }
  46. ```
  47. 3. **开始使用**:重启 Cursor,你就可以在对话中直接操作 YApi 了!
  48. ## 安装配置
  49. ### 方式一:npx 直接使用(推荐)
  50. 无需本地安装,通过 npx 直接运行:
  51. ```json
  52. {
  53. "mcpServers": {
  54. "yapi-auto-mcp": {
  55. "command": "npx",
  56. "args": [
  57. "-y",
  58. "yapi-auto-mcp",
  59. "--stdio",
  60. "--yapi-base-url=https://yapi.example.com",
  61. "--yapi-token=projectId:token1,projectId2:token2",
  62. "--yapi-cache-ttl=10",
  63. "--yapi-log-level=info"
  64. ]
  65. }
  66. }
  67. }
  68. ```
  69. ### 方式二:使用环境变量
  70. 在 MCP 配置中定义环境变量:
  71. ```json
  72. {
  73. "mcpServers": {
  74. "yapi-auto-mcp": {
  75. "command": "npx",
  76. "args": [
  77. "-y",
  78. "yapi-auto-mcp",
  79. "--stdio"
  80. ],
  81. "env": {
  82. "YAPI_BASE_URL": "https://yapi.example.com",
  83. "YAPI_TOKEN": "projectId:token1,projectId2:token2",
  84. "YAPI_CACHE_TTL": "10",
  85. "YAPI_LOG_LEVEL": "info"
  86. }
  87. }
  88. }
  89. }
  90. ```
  91. ### 方式三:本地开发模式
  92. 适合需要修改代码或调试的场景:
  93. 1. **克隆和安装**:
  94. ```bash
  95. git clone <repository-url>
  96. cd yapi-mcp
  97. pnpm install
  98. ```
  99. 2. **配置环境变量**(在项目根目录创建 `.env` 文件):
  100. ```env
  101. # YApi 基础配置
  102. YAPI_BASE_URL=https://your-yapi-domain.com
  103. YAPI_TOKEN=projectId:your_token_here,projectId2:your_token2_here
  104. # 服务器配置
  105. PORT=3388
  106. # 可选配置
  107. YAPI_CACHE_TTL=10
  108. YAPI_LOG_LEVEL=info
  109. ```
  110. 3. **启动服务**:
  111. **SSE 模式**(HTTP 服务):
  112. ```bash
  113. pnpm run dev
  114. ```
  115. 然后在 Cursor 中配置:
  116. ```json
  117. {
  118. "mcpServers": {
  119. "yapi-mcp": {
  120. "url": "http://localhost:3388/sse"
  121. }
  122. }
  123. }
  124. ```
  125. **Stdio 模式**:
  126. ```bash
  127. pnpm run build
  128. node dist/cli.js --stdio
  129. ```
  130. ## 使用指南
  131. ### 获取 YApi Token
  132. 1. 登录你的 YApi 平台
  133. 2. 进入项目设置页面
  134. 3. 在 Token 配置中生成或查看 Token
  135. ![Token 获取示例](./images/token.png)
  136. Token 格式说明:
  137. - 单项目:`projectId:token`
  138. - 多项目:`projectId1:token1,projectId2:token2`
  139. ### 使用示例
  140. 配置完成后,你可以在 Cursor 中这样使用:
  141. ![使用示例](./images/demo1.png)
  142. **常用操作示例**:
  143. 1. **搜索接口**:
  144. > "帮我找一下用户登录相关的接口"
  145. 2. **查看接口详情**:
  146. > "显示用户注册接口的详细信息"
  147. 3. **创建新接口**:
  148. > "帮我创建一个获取用户列表的接口,路径是 /api/users,使用 GET 方法"
  149. 4. **更新接口**:
  150. > "更新用户登录接口,添加验证码参数"
  151. ## 高级配置
  152. ### 命令行参数详解
  153. | 参数 | 描述 | 示例 | 默认值 |
  154. | ------------------ | ----------------------------- | ------------------------------------------ | ------ |
  155. | `--yapi-base-url` | YApi 服务器基础 URL | `--yapi-base-url=https://yapi.example.com` | - |
  156. | `--yapi-token` | YApi 项目 Token(支持多项目) | `--yapi-token=1026:token1,1027:token2` | - |
  157. | `--yapi-cache-ttl` | 缓存时效(分钟) | `--yapi-cache-ttl=10` | 10 |
  158. | `--yapi-log-level` | 日志级别 | `--yapi-log-level=info` | info |
  159. | `--port` | HTTP 服务端口(SSE 模式) | `--port=3388` | 3388 |
  160. | `--stdio` | 启用 stdio 模式(MCP 必需) | `--stdio` | - |
  161. ### 环境变量说明
  162. 创建 `.env` 文件进行配置:
  163. ```env
  164. # 必需配置
  165. YAPI_BASE_URL=https://your-yapi-domain.com
  166. YAPI_TOKEN=projectId:your_token_here
  167. # 可选配置
  168. PORT=3388 # HTTP 服务端口
  169. YAPI_CACHE_TTL=10 # 缓存时效(分钟)
  170. YAPI_LOG_LEVEL=info # 日志级别:debug, info, warn, error, none
  171. ```
  172. ### 日志级别说明
  173. - **debug**: 输出所有日志,包括详细的调试信息
  174. - **info**: 输出信息、警告和错误日志(默认)
  175. - **warn**: 只输出警告和错误日志
  176. - **error**: 只输出错误日志
  177. - **none**: 不输出任何日志
  178. ### 配置方式选择建议
  179. | 使用场景 | 推荐方式 | 优势 |
  180. | -------- | --------------------- | ------------------ |
  181. | 日常使用 | npx + 命令行参数 | 无需安装,配置简单 |
  182. | 团队共享 | npx + 环境变量 | 配置统一,易于管理 |
  183. | 开发调试 | 本地安装 + SSE 模式 | 便于调试和修改代码 |
  184. | 企业部署 | 本地安装 + stdio 模式 | 性能更好,更稳定 |

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.