Yapi MCP Server

基于模型上下文协议（MCP）的 Yapi 接口文档服务器，为 AI 助手提供与 Yapi 平台的无缝集成，支持通过自然语言查询接口详情。

功能特性

• getInterfaceDetail - 获取 Yapi 接口的详细信息

配置说明

服务器通过环境变量进行 Yapi 连接配置：

# Yapi 服务地址
YAPI_URL=http://yapi.example.com

# 项目令牌，JSON 格式：{"projectId": "token", "123": "your-token-1"}
YAPI_PROJECT_TOKENS={"123":"your-token-1","456":"your-token-2"}

环境变量通过 MCP 客户端配置传入。

使用方式

OpenCode 配置

在 MCP 配置中添加：

{
  "mcp": {
    "yapi": {
      "type": "local",
      "command": [
        "npx",
        "-y",
        "@morris131/yapi-mcp-server"
      ],
      "environment": {
        "YAPI_URL": "your_yapi_url",
        "YAPI_PROJECT_TOKENS": "{\"123\":\"your-project-token\"}"
      }
    }
  }
}

Claude Code 配置

运行以下命令添加 MCP 服务器：

claude mcp add yapi -e YAPI_URL=your_yapi_url -e YAPI_PROJECT_TOKENS={\"123\":\"your-project-token\"} -- npx -y @morris131/yapi-mcp-server

工具说明

getInterfaceDetail

获取 Yapi 接口的详细信息。

参数：

• interfaceId（必填）：Yapi 接口 ID
• projectId（必填）：Yapi 项目 ID（用于获取令牌）

示例：

{
  "interfaceId": 789,
  "projectId": 123456
}

返回内容：

• 基本信息（ID、标题、路径、请求方法）
• 请求信息（请求体类型、参数、请求头、查询参数）
• 响应信息（响应体类型、响应体、JSON Schema 标识）
• 其他信息（状态、Markdown 文档）