Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@mcp-yapi-servershow me the details for https://yapi.example.com/project/100/interface/api/12345"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
mcp-yapi-server
基于 Model Context Protocol (MCP) 的 YApi 集成服务器,在 Cursor 等支持 MCP 的编辑器中直接查询 YApi API 文档。
✨ 功能特性
🔗 直接粘贴 URL - 最简单!粘贴 YApi 链接即可查询
🔍 查询接口详情 - 完整的请求/响应参数
📋 列出接口 - 查看项目所有接口
🔎 搜索接口 - 按关键词搜索
🤖 AI 辅助 - 自动生成代码、类型定义等
📦 安装
或作为项目依赖:
🚀 快速开始
1. 安装
2. 配置 Cursor
在 Cursor 设置中添加 MCP 服务器配置:
推荐方式 - 本地安装:
或全局安装:
⚠️ 注意: 不推荐使用
npx方式,因为依赖可能无法正确解析。请使用本地安装或全局安装。
3. 重启 Cursor
4. 开始使用
在 Cursor 中直接粘贴 YApi 链接:
📚 文档
🔧 常见问题
"No server info found"
原因: Node.js 版本 < 18
解决: nvm install 18 && nvm use 18
"请登录..."
原因: 需要配置 Token
解决: 在 Cursor 配置中设置 YAPI_TOKEN
详见 故障排除文档
🛠 开发
📄 许可证
MIT License