Yapi Mcp Claude Plugin

yapi-mcp-claude-plugin

This repo is a claude code plugin within yapi-mcp-server to understanding api documents from https://github.com/YMFE/yapi.

rename the folder to 'yapi-mcp-plugin' if you like.

This project is not finished yet. basically these command/skills work, currently those are enough for MCP to query and understanding your Yapi api.

get_project
get_cat_menu
list_cat
get_interface

How to use

---------------------
 /yapi
---------------------
  /yapi-mcp:get_project                      get the Yapi Project information. (plugin:yapi-mcp@inline)
  /yapi-mcp:get_interface                    获得特定的接口信息 (plugin:yapi-mcp@inline)
  /yapi-mcp:list_cat                         Plugin command (plugin:yapi-mcp@inline)
  /yapi-mcp:get_cat_menu   
---------------------

--------------------
/yapi-mcp:get_interface 接口名称(interface name)
--------------------

Claude code will automatically using commands and skills to invoke MCP to retrieve project,category information until it collect enough parameters (such as interface id) to print full information.

Installing mcp-server-yapi

follow instructions by: https://github.com/kales0202/mcp-server-yapi

Installing mcp agent to claude code

claude mcp add -transport stdio yapi-mcp-server \
     --env YAPI_BASE_URL=<you-yapi-server>  \
     --env YAPI_TOKEN=<you-token-here> \
     -- node <your-path>/mcp-server-yapi/dist/index.js

Providing MCP server to Claude Code

create .mcp.json with contents below. for more details, see documents.

{
  "yapi-mcp-server": {
    "command": "node",
    "args": [
      "<your-path>/mcp-server-yapi/dist/index.js"
    ],
    "env": {
      "YAPI_BASE_URL": "<you-yapi-server>",
      "YAPI_TOKEN": "<you-token-here>",
      "MCP_DEBUG_CONSOLE": "false"
    }
  }
}

note: using node for local development, npx -y ... for npm (local)registry or market.