YAPI MCP Server

@YYvanYang

Repository

Basic information

About YAPI MCP Server

No overview available yet

#yapi #mcp #server

YAPI MCP Server config

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

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

YAPI MCP Server tools

A JSON string containing an array of categories, each with a list of simplified interface objects (id, title, path, method, status).

A JSON string containing the detailed interface information (request/response parameters, headers, body schemas, etc.).

Overview

What is YAPI MCP Server?

A Model Context Protocol (MCP) server that enables LLMs to retrieve API documentation details from YAPI projects. It connects to a running YAPI instance and provides tools for listing interface categories and getting detailed interface information.

How to use YAPI MCP Server?

Install via npx or Docker, set the YAPI_URL environment variable to your YAPI instance base URL, and configure the server in your MCP host (e.g., Claude Desktop). Use the yapi_list_interfaces tool with a project token to list interfaces, or yapi_get_interface_details with a project token and interface ID for full details.

Key features of YAPI MCP Server

List interface categories and basic interfaces in a YAPI project.
Get detailed interface info (request/response params, headers, schemas).
Input project token securely per call or via environment variable.
Returns structured JSON for easy LLM consumption.
Uses standard MCP tool interface.

Use cases of YAPI MCP Server

LLM automatically fetching API endpoint documentation from YAPI.
Providing developers with on-demand interface details during code generation.
Integrating YAPI docs into AI‑powered development assistants.

Frequently asked questions

What is YAPI?

YAPI is an API documentation management tool. This server interacts with a running YAPI instance.

How do I get a project token?

Find your YAPI project token in the project’s “Settings” → “Tokens” section.

What environment variables are required?

The `YAPI_URL` variable is required, set to the base URL of your YAPI instance. Optionally, `YAPI_PROJECT_TOKEN` can be used as a default (less secure, prefer passing via tool input).

What tools does the server provide?

It provides two tools: `yapi_list_interfaces` (lists categories and interfaces for a project) and `yapi_get_interface_details` (returns full details for a specific interface by ID).

How are credentials handled?

The project token is passed as an input argument to each tool. A default token can be set via the `YAPI_PROJECT_TOKEN` environment variable, but this is less secure because it would be shared across all calls.

Comments

More Other MCP servers

The Living Bread

A free remote MCP server for The Living Bread. Bible passages read word for word from a stored public domain text with an evidence label, keyword search and cross references, real churches, gatherings and prayer groups w

MaxKB

1Panel-dev

🔥 MaxKB is an open-source platform for building enterprise-grade agents. 强大易用的开源企业级智能体平台。

22.0K

Volley.sh

Volley

A good sequence diagram can solve almost any communication problem in engineering. Volley lets your agent write them as plain text, with the real request and response payloads on every arrow. It checks its own syntax wi

Glasswarp

See and control a real Windows PC you own — from any MCP client, locally or remotely. Observe (UIA + screenshots), click/type/drag/scroll, launch apps, owner Live View. BYOH: your machine, your key.

🚀 Model Context Protocol (MCP) Curriculum for Beginners

microsoft

This open-source curriculum introduces the fundamentals of Model Context Protocol (MCP) through real-world, cross-language examples in .NET, Java, TypeScript, JavaScript, Rust and Python. Designed for developers, it focuses on practical techniques for building modular, scalable,

16.7K