Yapi MCP Server

🚀 YAPI MCP Server

This is a Model Context Protocol (MCP) server that interacts with YAPI instances. The server enables large language models (LLMs) to retrieve API documentation details from your YAPI projects.

🚀 Quick Start

This server allows LLMs to interact with YAPI instances and retrieve API documentation details. Below are the main features and how to set it up.

✨ Features

• List interface categories and their basic interface information in a specific project.
• Get detailed information of a specific interface by its ID.

🛠️ Tools

yapi_list_interfaces

• List all interface categories and the interfaces they contain in a specific YAPI project.
• Input:
  • project_token (string): The token of the YAPI project (found in YAPI project settings -> Token).
• Return: A JSON string containing an array by category, with each category having a list of simplified interface objects (id, title, path, method, status).

yapi_get_interface_details

• Get detailed information of a specific YAPI interface by its ID.
• Input:
  • project_token (string): The token of the YAPI project.
  • interface_id (number): The ID of the specific YAPI interface (you can find this ID in the URL when viewing the interface in YAPI).
• Return: A JSON string containing detailed interface information (request/response parameters, headers, body schema, etc.).

📦 Installation

Prerequisites

1. A running YAPI instance.
2. Access to the project token of the YAPI project you want to interact with. You can find this token in the "Settings" -> "Token" section of your YAPI project.
3. Node.js and npm installed on the machine where you run the server or build the Docker image.

Configuration

The server needs to set the base URL of the YAPI instance through the YAPI_URL environment variable.

Using Claude Desktop

Add the following content to your claude_desktop_config.json:

NPX

{
  "mcpServers": {
    "yapi": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-yapi"
      ],
      "env": {
        "YAPI_URL": "http://your-yapi-instance.com"
        // If you want to hard - code the default token (not secure, it's recommended to pass it through the tool):
        // "YAPI_PROJECT_TOKEN": "YOUR_DEFAULT_PROJECT_TOKEN"
      }
    }
  }
}