Yapi-Mcp

MCP server that fetches YApi project API docs (JSON request / JSON response) so coding agents can integrate client projects from a pasted YApi URL.

Features

• Parse YApi page URLs → base_url / project_id / interface_id
• List / search interfaces, export catalogs
• Fetch normalized request & response JSON (JSON Schema / examples)
• Auth: login JWT (Cookie _yapi_token + _yapi_uid) or project open token
• Dynamic credentials: env, .env, .yapi-mcp.json, runtime yapi_configure, or per-tool args

Quick install (consumers)

Cursor / Claude Desktop MCP

{
  "mcpServers": {
    "yapi": {
      "command": "uvx",
      "args": ["--from", "contextdong-yapi-mcp", "yapi-mcp"],
      "env": {
        "YAPI_BASE_URL": "https://yapi.example.com",
        "YAPI_TOKEN": "YOUR_LOGIN_JWT_OR_PROJECT_OPEN_TOKEN"
      }
    }
  }
}

From Git (before / without PyPI):

{
  "mcpServers": {
    "yapi": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/ContextDong/Yapi-Mcp",
        "yapi-mcp"
      ],
      "env": {
        "YAPI_BASE_URL": "https://yapi.example.com",
        "YAPI_TOKEN": "YOUR_TOKEN"
      }
    }
  }
}

Or pip:

pip install contextdong-yapi-mcp
# or: pip install git+https://github.com/ContextDong/Yapi-Mcp

Configure credentials (no secrets in repo)

Priority (high → low):

1. Tool arguments (token, base_url)
2. Runtime yapi_configure (in-memory for the MCP process)
3. Environment / .env (YAPI_BASE_URL, YAPI_TOKEN, YAPI_UID, YAPI_COOKIE)
4. Config file .yapi-mcp.json or path in YAPI_MCP_CONFIG

Copy examples:

cp .env.example .env
cp .yapi-mcp.example.json .yapi-mcp.json

Never commit .env, .yapi-mcp.json, or real tokens.

Tools

Agent usage

Paste a project URL in chat:

Integrate APIs from https://yapi.example.com/project/123/interface/api/

The agent should configure credentials (if needed), list interfaces, pull details, then implement the client against your codebase conventions.

Project skill (optional): .cursor/skills/yapi-api-client/SKILL.md

Local development

python -m pip install -e ".[dev]"
python -m pytest
python -m yapi_mcp.server

MCP Registry

Official registry name: io.github.ContextDong/yapi-mcp
Package: PyPI contextdong-yapi-mcp (stdio via uvx / yapi-mcp)
Note: the shorter name yapi-mcp is already taken on PyPI by another project.

License

MIT