MCP.so
Sign In

Yapi MCP Server

@lzsheng

Basic information

Category

Other

License

MIT

Transports

stdio

Author

lzsheng

About Yapi MCP Server

yapi mcp server

Yapi MCP Server config

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

{
  "mcpServers": {
    "Yapi-MCP": {
      "command": "node",
      "args": [
        "dist/cli.js",
        "--stdio"
      ]
    }
  }
}

Yapi MCP Server tools

Tool list not available yet

This listing does not currently have a tool list to display. This does not mean the server has no tools; check its documentation for supported capabilities.

We auto-extract tools from the README. The maintainer can list them under a ## Tools heading to populate this section.

Overview

What is Yapi MCP Server?

Yapi MCP Server is a Model Context Protocol (MCP) server for the YApi API management platform. It allows developers to search, view, create, and update YApi interface documents directly within AI coding tools like Cursor and Claude Desktop.

How to use Yapi MCP Server?

The recommended way is using npx without installation. Configure the MCP server in your Cursor settings with the command npx -y yapi-auto-mcp --stdio --yapi-base-url=<URL> --yapi-token=<projectId:token>. Alternatively, use environment variables or a local development mode with SSE or stdio transport.

Key features of Yapi MCP Server

  • Search and view YApi interface documents
  • Create and update API definitions
  • Manage projects and categories structure
  • Support for multiple YApi project configurations
  • Built-in caching for faster responses
  • Detailed logging for debugging and monitoring

Use cases of Yapi MCP Server

  • Search for a specific API by name or path during AI-assisted coding
  • View full request/response details of an endpoint
  • Create a new API endpoint directly from a chat prompt
  • Update an existing API definition to add parameters or change paths
  • Manage multiple YApi projects from a single MCP server instance

Frequently asked questions

1

How do I obtain a YApi token?

Log in to your YApi platform, go to project settings, and generate or view the token. For multiple projects, combine tokens as `projectId1:token1,projectId2:token2`.

2

What are the supported transport modes?

Yapi MCP Server supports both stdio mode (for standard MCP integration) and SSE mode (HTTP service on port 3388 by default). Use `--stdio` for stdio or set `--port` and configure the URL for SSE.

3

What runtime dependencies are required?

Node.js and npx are required. The server runs entirely via npx, so no local installation is needed for daily use. For local development, clone the repository and use `pnpm install` and `pnpm run build`.

4

How do I configure caching and logging?

Use `--yapi-cache-ttl` (default 10 minutes) for cache duration and `--yapi-log-level` (debug/info/warn/error/none) for logging verbosity. These can also be set via environment variables.

5

Can I use environment variables instead of command-line arguments?

Yes. Define `YAPI_BASE_URL`, `YAPI_TOKEN`, `YAPI_CACHE_TTL`, `YAPI_LOG_LEVEL`, and `PORT` in a `.env` file or in the MCP server configuration’s `env` field.

Comments

More Other MCP servers