yapi_get_interface_detailLABSCO SUMMARY
The spec arrives in the session at the moment the code gets written against it.
The flow the two tools describe is list, then fetch: yapi_get_interfaces takes a url and yapi_get_interface_detail takes an id, which comes from the listing. Both read — nothing here creates or edits an interface, so YApi remains the place a spec changes. Authentication carries YAPI_COOKIE alongside YAPI_TOKEN, which makes a session cookie part of what has to stay valid for the calls to land.
What it is
A read-side YApi client: the interface index for a URL, and the detail for a single interface id.
What you get
- yapi_get_interfaces returns the interfaces found at a YApi url you pass.
- yapi_get_interface_detail returns the full definition of one interface, addressed by its id.
Requirements
A YApi instance at BASE_URL, plus YAPI_TOKEN and YAPI_COOKIE for the account whose view of the project the server reads.
Setup effort
One command plus a key — npx -y auto-yapi-mcp, then supply credentials
USE CASES
01
Writing a client against an interface someone changed this morning
List what the YApi URL holds, then pull the one interface's definition by id so the code is written against the current shape rather than a stale copy.
2 tools
Counted once with only startup setup. Other versions, modes or optional credentials may expose a different list.
yapi_get_interfacesBEFORE YOU INSTALL
What to know first
Tools you get
2 tools when we connected.
Requires
- npx on PATH
- node>18
- YAPI_TOKEN in your environment
CONTEXT COST
Light Standing cost
Rated by the size of the 2 tool definitions that ride along on every turn, not by how many there are
INSTALLATION
Connect your client
Server setup
TERMINAL
npx -y auto-yapi-mcpMCP Clients
Cursor
CURSOR · JSON
{
"mcpServers": {
"auto-yapi-mcp": {
"command": "npx",
"args": [
"-y",
"auto-yapi-mcp"
],
"env": {
"YAPI_TOKEN": "<YOUR_YAPI_TOKEN>",
"BASE_URL": "https://<YOUR_FED>",
"YAPI_COOKIE": "<YOUR_YAPI_COOKIE>"
}
}
}
}
