mcp -yapi

mcp-server-yapi 将 YApi 的核心功能封装为一组可通过 MCP 协议调用的工具，便于大型语言模型（LLM）与 YApi 平台进行自然语言交互以实现接口管理自动化。通过该服务器，LLM 可以执行项目信息查询、接口创建与更新、分类管理、数据导入以及获取接口列表等操作，从而在无需直接操作 YApi 界面的情况下完成日常维护任务。你可以使用支持 MCP 的客户端将以下工具名映射成命令、完成对应的任务：get_project、add_cat、get_cat_menu、list_cat、list_menu、get_interface、list_interface、save_interface、add_interface、up_interface、import_data。配置中通过环境变量传入 YApi 的访问地址和 TOKEN，确保请求授权与身份验证。

Prerequisites:

• Node.js >= 18.x
• 具有 MCP 客户端，或准备通过 npx 触发 MCP 服务

Installation steps:

1. 使用 npx 直接运行（无需本地安装）：

   • 使用前提：已在支持 MCP 的环境中，确保网络可访问 npm registry。
   • 运行示例： npx -y mcp-server-yapi 说明：首次执行时会安装并启动服务器，按提示设置环境变量。

2. 本地安装并构建后再运行（推荐用于本地调试/长期使用）：

   • 克隆仓库并进入目录： git clone https://github.com/kales0202/mcp-server-yapi.git cd mcp-server-yapi
   • 安装依赖： npm install
   • 构建产物（如需要将代码编译到 dist/index.js）： npm run build
   • 按需以 Node 直接运行 dist/index.js，或通过 MCP 客户端以 npx 方式调用该服务（如上所示）。

3. 客户端配置示例（将服务添加到你的 MCP 客户端配置中）： { "mcpServers": { "mcp-server-yapi": { "command": "node", "args": ["/absolute/path/to/your/mcp-server-yapi/dist/index.js"], "env": { "YAPI_BASE_URL": "YAPI服务地址", "YAPI_TOKEN": "项目TOKEN", "MCP_DEBUG_CONSOLE": "false" } } } }

提示与常见问题：

• 确保 YAPI_BASE_URL 指向你的 YApi 实例的 Base URL，并且 TOKEN 具备所需的访问权限。
• MCP_DEBUG_CONSOLE 如设为 true，将在控制台输出更多调试信息，便于排错。
• 使用 npx 运行时，确保网络能访问 npm registry；若网络受限，优先通过本地构建后的 dist/index.js 运行。
• 在集成 AI Agent 时，确保传入的环境变量与 Authorization 配置一致，以避免身份认证错误。
• 兼容性：该服务主要设计用于与 YApi 的版本配合工作，请根据你部署的 YApi 版本调整 TOKEN 配置与接口访问路径。