YapiSAFE

一个用于 YApi 的 Model Context Protocol (MCP) 服务器,让你能够在 Cursor 等 AI 编程工具中直接操作 YApi 接口文档。

项目简介

Yapi Auto MCP Server 是一个基于 Model Context Protocol 的服务器,专为 YApi 接口管理平台设计。它允许你在 Cursor、Claude Desktop 等支持 MCP 的 AI 工具中直接:

• 🔍 搜索和查看 YApi 项目中的接口文档
• ✏️ 创建和更新 接口定义
• 📋 管理项目和分类 结构
• 🔗 无缝集成 AI 编程工作流
• 🛠 支持多个 YApi Project配置

通过 MCP 协议,AI 助手可以理解你的 YApi 接口结构,在编程过程中提供更准确的建议和代码生成。

主要功能

🔍 接口查询和搜索

• yapi_search_apis: 按名称、路径、标签等条件搜索接口
• yapi_get_api_desc: 获取特定接口的详细信息(请求/响应结构、参数等)
• yapi_list_projects: 列出所有可访问的项目
• yapi_get_categories: 获取项目下的接口分类和接口列表

✏️ 接口管理

• yapi_save_api: 创建新接口或更新现有接口
• 支持完整的接口定义(路径、方法、参数、请求体、响应等)
• 支持 JSON Schema 和表单数据格式
• 自动处理接口状态和分类管理

🎯 智能特性

• 多项目支持: 同时管理多个 YApi 项目
• 缓存机制: 提高查询响应速度
• 详细日志: 便于调试和监控
• 灵活配置: 支持环境变量和命令行参数

快速开始

推荐方式:使用 npx(无需安装)

1. 获取 YApi Token:登录你的 YApi 平台,在项目设置中获取 Token
2. 配置 Cursor:在 Cursor 设置中添加 MCP 服务器:

{
"mcpServers": {
"yapi-auto-mcp": {
"command": "npx",
"args": [
"-y",
"yapi-auto-mcp",
"--stdio",
"--yapi-base-url=https://your-yapi-domain.com",
"--yapi-token=projectId:your_token_here"
]
}
}
}

1. 开始使用:重启 Cursor,你就可以在对话中直接操作 YApi 了!

安装配置

方式一:npx 直接使用(推荐)

无需本地安装,通过 npx 直接运行:

{
"mcpServers": {
"yapi-auto-mcp": {
"command": "npx",
"args": [
"-y",
"yapi-auto-mcp",
"--stdio",
"--yapi-base-url=https://yapi.example.com",
"--yapi-token=projectId:token1,projectId2:token2",
"--yapi-cache-ttl=10",
"--yapi-log-level=info"
]
}
}
}

方式二:使用环境变量

在 MCP 配置中定义环境变量:

{
"mcpServers": {
"yapi-auto-mcp": {
"command": "npx",
"args": [
"-y",
"yapi-auto-mcp",
"--stdio"
],
"env": {
"YAPI_BASE_URL": "https://yapi.example.com",
"YAPI_TOKEN"