Skip to main content
Glama
@wllcyg/yapi-mcp

@wllcyg/yapi-mcp

by wllcyg

@wllcyg001/yapi-mcp

YApi MCP Server(Node.js + MCP SDK),提供按需查询的两个核心工具:

  • search_yapi_interfaces

  • get_yapi_interface_detail

Token 仅支持 project 级。group 级 URL 不支持鉴权。

1. 安装与构建

npm install
npm run build

本地开发:

npm run dev

Related MCP server: YApi MCP Server

2. 配置

环境变量

  • YAPI_BASE_URL(必填)

  • YAPI_TOKEN_FILE(可选,默认 ~/.yapi-mcp-tokens.json)

  • YAPI_TIMEOUT_MS(可选,默认 8000)

  • YAPI_RETRY_COUNT(可选,默认 1)

  • YAPI_TOKEN(可选,单项目临时兜底)

Token 文件

路径:~/.yapi-mcp-tokens.json

{
  "695": "token_for_project_695",
  "703": "token_for_project_703"
}

3. MCP 客户端配置示例(Cursor)

{
  "mcpServers": {
    "yapi": {
      "command": "node",
      "args": ["D:/self/yapi-mcp/dist/index.js"],
      "env": {
        "YAPI_BASE_URL": "http://10.255.30.245:3000"
      }
    }
  }
}

如果你后续发布 npm 包,也可改为:

{
  "mcpServers": {
    "yapi": {
      "command": "npx",
      "args": ["-y", "@wllcyg001/yapi-mcp"],
      "env": {
        "YAPI_BASE_URL": "http://10.255.30.245:3000"
      }
    }
  }
}

4. 工具定义

search_yapi_interfaces

输入:

  • keyword: string(必填)

  • projectId?: number

  • projectUrl?: string(如 .../project/695/interface/api)

  • method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH"

  • pathHint?: string

  • limit?: number(默认 10,最大 50)

输出:

  • 匹配接口列表:interfaceId / name / method / path / projectId / score

get_yapi_interface_detail

输入:

  • interfaceId: number(必填)

  • projectId?: number

  • projectUrl?: string

  • includeMock?: boolean(默认 false)

输出:

  • 接口详情(request/response schema,默认不返回 mock)

5. 错误码

  • INVALID_ARGUMENT

  • PROJECT_ID_REQUIRED

  • PROJECT_TOKEN_REQUIRED

  • TOKEN_SCOPE_UNSUPPORTED

  • PROJECT_NOT_ACCESSIBLE

  • INTERFACE_NOT_FOUND

  • UPSTREAM_TIMEOUT

  • UPSTREAM_ERROR

  • RATE_LIMITED

Available Tools

2 tools
get_yapi_interface_detailA

Get YApi interface detail including request/response schema. Token scope is project-level only.

Inputs: interfaceId (required), projectId, projectUrl, includeMock.

search_yapi_interfacesA

Search YApi interfaces by natural language keyword within a project. Token scope is project-level only.

Inputs: keyword (required), limit, method, pathHint, +2 more.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.8/5.0

    Scored across 2 tools

    Disambiguation5/5

    Search and detail retrieval are clearly distinct stages in the workflow—one identifies interfaces, the other inspects a specific one. No functional overlap exists, so an agent can easily choose the right tool.

    Naming Consistency5/5

    Both tools follow a consistent verb_noun pattern with snake_case: search_yapi_interfaces and get_yapi_interface_detail. The verb-first style is uniform and predictable.

    Tool Count3/5

    With only 2 tools, the server feels minimal for a YApi integration. This is borderline for the rubric's definition of a thin tool set, though it could be defensible if the scope is intentionally limited to read-only search and retrieval.

    Completeness4/5

    The read-only workflow is well covered: search for interfaces and retrieve full details. However, there is no way to list all interfaces without a keyword, and no CRUD or project-level operations, which are reasonable gaps for the stated purpose.

    Maintenance

    ActivityInactive
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers