drio
Open app

Yapi MCP Server

Source

yapi mcp server

Catalog onlyCatalog onlySTDIO

Overview

Yapi MCP Server is a server application designed to interact with the YApi platform, providing tools for managing and retrieving API descriptions.

To use Yapi MCP Server, clone the repository from GitHub, install the dependencies using pnpm install, and run the server with pnpm run dev. Configure the environment variables in a .env file as specified in the documentation.

  • Integration with YApi for API management - Tool to retrieve API descriptions by ID - Customizable server configuration through environment variables
  1. Managing API documentation for development teams.
  2. Retrieving specific API details for integration purposes.
  3. Facilitating communication between frontend and backend teams regarding API usage.

Add to your AI client

Use these steps to connect Yapi MCP Server in Cursor, Claude, VS Code, and other MCP-compatible apps. The same JSON appears in the Use with menu above for one-click copy.

Cursor

Add this to your .cursor/mcp.json file in your project root, then restart Cursor.

.cursor/mcp.json

{
  "mcpServers": {
    "yapi-mcp-lzsheng": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-yapi-mcp-lzsheng"
      ]
    }
  }
}

Claude Desktop

Add this server entry to the mcpServers object in your Claude Desktop config, then restart the app.

~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows)

{
  "mcpServers": {
    "yapi-mcp-lzsheng": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-yapi-mcp-lzsheng"
      ]
    }
  }
}

Claude Code

Add this to your project's .mcp.json file. Claude Code will detect it automatically.

.mcp.json (project root)

{
  "mcpServers": {
    "yapi-mcp-lzsheng": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-yapi-mcp-lzsheng"
      ]
    }
  }
}

VS Code (Copilot)

Add this to your .vscode/mcp.json file. Requires the GitHub Copilot extension with MCP support enabled.

.vscode/mcp.json

{
  "servers": {
    "yapi-mcp-lzsheng": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-yapi-mcp-lzsheng"
      ]
    }
  }
}

Windsurf

Add this to your Windsurf MCP config file, then restart Windsurf.

~/.codeium/windsurf/mcp_config.json

{
  "mcpServers": {
    "yapi-mcp-lzsheng": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-yapi-mcp-lzsheng"
      ]
    }
  }
}

Cline

Open Cline settings, navigate to MCP Servers, and add this server configuration.

Cline MCP Settings (via UI)

{
  "mcpServers": {
    "yapi-mcp-lzsheng": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-yapi-mcp-lzsheng"
      ]
    }
  }
}

FAQ

What is YApi?

YApi is an open-source API management platform that helps teams manage their APIs effectively.

How do I configure the server?

You need to create a `.env` file in the project root and set the required environment variables as described in the documentation.

Is Yapi MCP Server free to use?

Yes! Yapi MCP Server is open-source and free to use.

Developer tools