Yapi MCP Server

🚀 YAPI MCP 服务器

YAPI MCP 服务器是一个与 YAPI 实例交互的 Model Context Protocol (MCP) 服务器。它能让大型语言模型 (LLMs) 从您的 YAPI 项目中检索 API 文档详细信息，为开发工作提供便利。

✨ 主要特性

• 可列出特定项目中的接口类别及其基本接口信息。
• 能按接口 ID 获取特定接口的详细信息。

📦 安装指南

⚙️ 前提条件

1. 需有一个正在运行的 YAPI 实例。
2. 要获取您要交互的 YAPI 项目的项目令牌，可在 YAPI 项目“设置” -> “令牌”部分找到。
3. 在运行服务器或构建 Docker 镜像的机器上安装 Node.js 和 npm。

🛠️ 配置

该服务器需要通过 YAPI_URL 环境变量设置 YAPI 实例的基础 URL。

📝 使用 Claude Desktop

将以下内容添加到您的 claude_desktop_config.json 中：

NPX

{
  "mcpServers": {
    "yapi": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-yapi"
      ],
      "env": {
        "YAPI_URL": "http://your-yapi-instance.com"
        // 如果您想硬编码默认令牌（不安全，建议通过工具传递）：
        // "YAPI_PROJECT_TOKEN": "YOUR_DEFAULT_PROJECT_TOKEN"
      }
    }
  }
}

💻 使用示例

工具介绍

1. yapi_list_interfaces

• 功能：列出特定 YAPI 项目的所有接口类别及其包含的接口。
• 输入：
  • project_token (字符串)：YAPI 项目的令牌（在 YAPI 项目设置 -> 令牌中找到）。
• 返回：一个 JSON 字符串，包含按类别的数组，每个类别有一个简化的接口对象列表（id、标题、路径、方法、状态）。

2. yapi_get_interface_details

• 功能：根据其 ID 获取特定 YAPI 接口的详细信息。
• 输入：
  • project_token (字符串)：YAPI 项目的令牌。
  • interface_id (数字)：特定 YAPI 接口的 ID（您可以在 YAPI 中查看接口时在其 URL 中找到该 ID）。
• 返回：一个 JSON 字符串，包含详细的接口信息（请求/响应参数、头、正文模式等）。