get_projectLABSCO SUMMARY
Covers the write side of YApi, not just reading it.
Most documentation bridges stop at lookup. Here the create, update and upsert calls are all exposed, so an assistant that just wrote a handler can register the matching interface in the same turn. The token is per-project, which keeps the blast radius to one project rather than the whole YApi instance.
What it is
A Node server that wraps the everyday YApi endpoints — projects, categories, interfaces — so an assistant can manage API documentation in your own YApi deployment. Access is scoped by a per-project token, so it only reaches the project whose token you paste in.
What you get
get_projectreturns the project's basic informationadd_catcreates an interface category;get_cat_menuandlist_menureturn the category and interface menuslist_catandlist_interfacelist the interfaces under a category or across the projectget_interfacereads one interface definition in fulladd_interface,up_interfaceandsave_interfacecreate, update, or create-or-update an interfaceimport_datapushes a batch of interface data into the project
Requirements
The npm package mcp-server-yapi, version 0.1.2, run as npx -y mcp-server-yapi on Node.js >= v18.0.0. Set YAPI_BASE_URL to your YApi address and YAPI_TOKEN to the project token from the project's settings; MCP_DEBUG_CONSOLE turns debug output on or off.
Setup effort
One command plus a key — npx -y mcp-server-yapi, then supply credentials
USE CASES
Documenting an endpoint you just wrote
Describe the route, and have it filed under the right category in YApi rather than typing the form.
Finding out what a project already exposes
Walk the category menu and interface list before adding something that already exists.
Correcting a stale definition
Read the current definition, then write the corrected version back in place.
Seeding a new project
Create the categories first, then push interface data in one batch.
11 tools
Listed in project docs. Your client may show a different list.
add_catget_cat_menulist_catlist_menuget_interfacelist_interfacesave_interfaceadd_interfaceup_interfaceimport_dataBEFORE YOU INSTALL
What to know first
Tools you get
11 tools named in the project's documentation.
Requires
- npx on PATH
- Node.js >= v18.0.0
- YAPI_TOKEN in your environment
Where it runs
All 3 documented clients run the server on your machine.
INSTALLATION
Connect your client
Server setup
npx -y mcp-server-yapiMCP Clients
Cursor, Windsurf, Claude Desktop
{
"mcpServers": {
"mcp-server-yapi": {
"command": "npx",
"args": [
"-y",
"mcp-server-yapi"
],
"env": {
"YAPI_BASE_URL": "<YOUR_YAPI_BASE_URL>",
"YAPI_TOKEN": "<YOUR_YAPI_TOKEN>",
"MCP_DEBUG_CONSOLE": "false"
}
}
}
}