Mcp Yapi Server

mcp-yapi-server

基于 Model Context Protocol (MCP) 的 YApi 集成服务器，在 Cursor 等支持 MCP 的编辑器中直接查询 YApi API 文档。

✨ 功能特性

• 🔗 直接粘贴 URL - 最简单！粘贴 YApi 链接即可查询
• 🔍 查询接口详情 - 完整的请求/响应参数
• 📋 列出接口 - 查看项目所有接口
• 🔎 搜索接口 - 按关键词搜索
• 🤖 AI 辅助 - 自动生成代码、类型定义等

📦 安装

npm install -g mcp-yapi-server

或作为项目依赖：

npm install mcp-yapi-server

🚀 快速开始

1. 安装

npm install -g mcp-yapi-server

2. 配置 Cursor

在 Cursor 设置中添加 MCP 服务器配置：

推荐方式 - 本地安装：

# 在项目目录中安装
npm install mcp-yapi-server

{
  "mcpServers": {
    "yapi": {
      "command": "node",
      "args": ["./node_modules/mcp-yapi-server/dist/index.js"],
      "env": {
        "YAPI_BASE_URL": "https://yapi.example.com",
        "YAPI_TOKEN": "your_token_here"
      }
    }
  }
}

或全局安装：

npm install -g mcp-yapi-server

{
  "mcpServers": {
    "yapi": {
      "command": "mcp-yapi-server",
      "env": {
        "YAPI_BASE_URL": "https://yapi.example.com",
        "YAPI_TOKEN": "your_token_here"
      }
    }
  }
}

⚠️ 注意: 不推荐使用 npx 方式，因为依赖可能无法正确解析。请使用本地安装或全局安装。

3. 重启 Cursor

4. 开始使用

在 Cursor 中直接粘贴 YApi 链接：

https://yapi.example.com/project/100/interface/api/12345

📚 文档

• 快速开始指南
• 使用指南
• 故障排除

🔧 常见问题

"No server info found"

原因: Node.js 版本 < 18
解决: nvm install 18 && nvm use 18

"请登录..."

原因: 需要配置 Token
解决: 在 Cursor 配置中设置 YAPI_TOKEN

详见 故障排除文档

🛠 开发

# 克隆项目
git clone https://github.com/TStoneLee/mcp-yapi-server.git
cd mcp-yapi-server

# 安装依赖
npm install

# 开发模式
npm run dev

# 构建
npm run build

📄 许可证

MIT License

🔗 相关链接

• Model Context Protocol
• YApi 官方文档
• Cursor 编辑器