Yapi Fetch Mcp

Name: Yapi Fetch Mcp
Author: xiaozhi666666

@xiaozhi666666

Repository

About Yapi Fetch Mcp

Reusable MCP server for reading YApi interface metadata from a URL, interface ID, or project ID.

#yapi-mcp-fetch-https-typescript

Basic information

Config

Add this server to your MCP-compatible client using the configuration below.

{
  "mcpServers": {
    "yapi": {
      "command": "npx",
      "args": [
        "-y",
        "yapi-fetch-mcp"
      ],
      "env": {
        "YAPI_HOST": "https://yapi.example.com",
        "YAPI_TOKEN": "project-token"
      }
    }
  }
}

Tools

Read one YApi interface by URL or interface ID and return normalized request/response metadata.

Read a YApi project's interface menu. Useful for discovering interface IDs before calling get_interface.

Search/list YApi project interfaces with pagination.

Overview

What is Yapi Fetch Mcp?

Yapi Fetch Mcp is an MCP server for reading YApi interface metadata. It can fetch interface path, request parameters, request body, and response structure via YApi page URL, interface ID, or project ID. It is intentionally project‑agnostic, pulling structured data while leaving code generation (services, types, models, API clients) to the coding agent.

How to use Yapi Fetch Mcp?

Install globally with npm install -g yapi-fetch-mcp. Configure environment variables YAPI_HOST and either YAPI_TOKEN (project token) or YAPI_COOKIE (browser cookie). Then add the server to your MCP client (e.g., Codex) using npx -y yapi-fetch-mcp or the global command. Authentication can also be passed directly in tool parameters.

Key features of Yapi Fetch Mcp

Retrieve single interface detail by YApi page URL or interface ID.
Read a YApi project’s full interface directory.
Search project interfaces by keyword with pagination.
Supports both project‑token and cookie/session authentication.
Returns normalized request/response metadata; optionally includes raw YApi data.

Use cases of Yapi Fetch Mcp

AI coding agents automatically understanding API endpoints documented in YApi.
Generating TypeScript types, service stubs, or API clients from YApi definitions.
Searching for interfaces by keyword across a YApi project.
Retrieving interface details without manual browsing when building integration tools.

FAQ from Yapi Fetch Mcp

How do I get a long‑term token?

The YAPI_TOKEN is a project‑level token found in your YApi project’s Settings page (under “Token” or “Project Token”).

What if my YApi uses `Authorization: Bearer` instead of a query‑parameter token?

The current version sends the token only as a query parameter. If your access token must go in the Authorization header, use YAPI_COOKIE instead, or extend the code for your private YApi.

Can I authenticate with a browser cookie?

Yes. Set the YAPI_COOKIE environment variable with the full cookie string (e.g., _yapi_token=...; _yapi_uid=...). This works for YApi instances that require login.