Yapi Auto

You can run the Yapi Auto MCP Server to manage YApi interface documentation from MCP-enabled AI tools. It lets you search, view, create, and update API definitions across multiple YApi projects and integrate these capabilities directly into your AI-assisted development workflow.

How to use

Connect your MCP client (such as Cursor or Claude Desktop) to the server, then start issuing natural language requests to manage YApi documents. You can search for interfaces by name, path, or tags, view detailed API descriptions, create or update interfaces, and organize projects and categories. The server supports multiple YApi projects, caches queries for speed, logs detailed information for debugging, and accepts environment variables and command line options for flexible configuration.

How to install

Prerequisites: you need Node.js (for npx usage) or a local development environment if you plan to modify the code. You will run one of the MCP configurations shown below to connect your MCP client to the Yapi Auto MCP Server.

Configuration and usage snippets

{
  "mcpServers": {
    "yapi_mcp_http": {
      "type": "http",
      "name": "yapi_mcp_http",
      "url": "http://localhost:3388/sse",
      "args": []
    }
  },
  "envVars": []
}

{
  "mcpServers": {
    "yapi_mcp_stdio": {
      "type": "stdio",
      "name": "yapi_auto_mcp_stdio",
      "command": "npx",
      "args": [
        "-y",
        "yapi-auto-mcp",
        "--stdio",
        "--yapi-base-url=https://your-yapi-domain.com",
        "--yapi-token=projectId:your_token_here"
      ]
    }
  }
}

{
  "mcpServers": {
    "yapi_mcp_stdio_env": {
      "type": "stdio",
      "name": "yapi_auto_mcp_stdio_env",
      "command": "npx",
      "args": [
        "-y",
        "yapi-auto-mcp",
        "--stdio"
      ],
      "env": {
        "YAPI_BASE_URL": "https://your-yapi-domain.com",
        "YAPI_TOKEN": "projectId:token1,projectId2:token2",
        "YAPI_CACHE_TTL": "10",
        "YAPI_LOG_LEVEL": "info"
      }
    }
  }
}

Installation steps in detail

Choose one of the two primary installation approaches. If you prefer not to install locally, run via npx. If you want local development or customization, clone the project, install dependencies, and run the server in SSE or stdio mode as shown.

Additional configuration notes

The server supports multiple YApi projects, a caching mechanism to speed up searches, detailed logs for debugging, and flexible configuration through environment variables and command line arguments.

Troubleshooting and tips

If you encounter connection issues, verify that the MCP server URL is reachable from your MCP client, check that the YApi tokens are correct, and ensure the base URL matches your YApi deployment. Review logs for any authentication or network errors and adjust cache settings if queries are slow.

Notes on security and usage

Keep your YApi tokens secure and avoid exposing them in shared configurations. Use environment variables for sensitive data when possible and restrict access to the MCP server to trusted clients.

Available tools

yapi_search_apis

Search interfaces by name, path, or tags within YApi projects.

yapi_get_api_desc

Retrieve detailed information for a specific API, including parameters, request/response schemas.

yapi_list_projects

List all accessible YApi projects.

yapi_get_categories

Get the categories and API list for a given project.

yapi_save_api

Create or update an API definition with support for JSON Schema and form data; handles status and categorization.