Skip to main content
Glama

YApi MCP Server

English 中文

A MCP (Model Context Protocol) server for accessing YApi interface documentation.

Features

  • 📝 Get interface details by ID

  • 🔗 Support YApi URL auto-parsing

Related MCP server: YApi MCP Server

Claude Desktop Configuration

{
  "mcpServers": {
    "yapi": {
      "command": "npx",
      "args": ["-y", "yapi-mcp-server@latest"],
      "env": {
        "YAPI_BASE_URL": "http://your-yapi-server.com",
        "YAPI_TOKEN": "your-yapi-token"
      }
    }
  }
}

Environment Variables

  • YAPI_BASE_URL: Your YApi server URL

  • YAPI_TOKEN: YApi access token

How to Get Token

Login to YApi → Profile Settings → Copy Token

Usage

Direct URL

Please get the information for this interface: http://localhost:40001/project/11/interface/api/23

Tool Name

Please use yapi-get-interface tool to get details for interface ID 789

License

MIT

Available Tools

2 tools
yapi-get-interfaceB

根据接口ID获取接口详情

Inputs: interfaceId (required).

yapi-get-interface-by-urlC

根据YApi URL获取接口详情,支持格式如:http://localhost:40001/project/11/interface/api/23

Inputs: url (required).

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

    TDQS

    B3.1/5.0

    Scored across 2 tools

    Disambiguation5/5

    The two tools have clearly distinct purposes: one retrieves interface details by ID, while the other retrieves them by URL. There is no overlap or ambiguity between their functions, making it easy for an agent to select the correct tool based on the available input.

    Naming Consistency5/5

    Both tools follow a consistent naming pattern: 'yapi-get-interface' with a suffix indicating the input type ('-by-url'). This verb_noun structure is uniform and predictable, enhancing readability and usability across the tool set.

    Tool Count2/5

    With only 2 tools, the server feels under-scoped for a YApi (API management) domain. This minimal set lacks essential operations like creating, updating, or listing interfaces, which are typical for such systems, making it insufficient for comprehensive agent workflows.

    Completeness2/5

    The tool surface is severely incomplete for API management. It only provides retrieval methods (by ID and URL), missing critical CRUD operations such as create, update, delete, or list interfaces. This creates significant gaps that will likely cause agent failures in handling full lifecycle tasks.

    Maintenance

    ActivityInactive
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      B
      quality
      D
      maintenance
      Enables direct integration with YApi API documentation platform in MCP-compatible editors like Cursor, allowing users to query API details, list interfaces, and search endpoints by simply pasting YApi URLs.
      5
      10 npm
      MIT
    • A
      license
      Not graded
      quality
      D
      maintenance
      Enables reading and searching API documentation from YApi instances, allowing AI models to access interface definitions, project API lists, and search through API endpoints using YApi URLs or project IDs.
      5 npm
      MIT
    • A
      license
      Not graded
      quality
      D
      maintenance
      Enables interaction with YApi API management platform through natural language, allowing automated interface management including creating/updating APIs, managing categories, importing data, and retrieving project information.
      26 npm
      9
      GPL 3.0
    • A
      license
      A
      quality
      D
      maintenance
      Enables LLM clients to browse and inspect YAPI API documentation, including project info, categories, interfaces, and full API details with request/response schemas.
      7
      10 npm
      1
      MIT