listProjectsLABSCO SUMMARY
The interface definition, fetched instead of remembered.
Search by path or keyword and get the request and response shape back in place, so writing a client stops involving a second window. The cache is under your control — refresh it, clear one project, or check what is in it before you doubt an answer.
What it is
A Java server over the Yapi API management platform: it lists your configured projects and their interface categories, searches interfaces by name or path, and returns the full definition of one.
What you get
- Configured Yapi projects listed with their IDs and names
- The interface categories in a project, and the interfaces inside a category
- Search by project name, keyword or path
- Full detail for a single interface
- A local cache you control: statistics, a manual refresh, and a per-project clear
Requirements
Your Yapi instance URL and a token per project, set in application-mcp.yml. JDK 21+ with Maven, or Docker Compose.
Setup effort
Follow the published steps — git clone https://github.com/yyykf/yapi-mcp-server.git
USE CASES
01
Writing a client against an interface you just found
Search by path, then pull the full definition so the request and response shapes come from Yapi rather than from memory.
02
Getting your bearings in an unfamiliar project
List the configured projects, then the categories inside the one you have been handed.
03
Reviewing everything in one module
List the interfaces in a category rather than searching for names you do not know yet.
04
Picking up a definition that changed this morning
Refresh the cache first, then read the detail, so you are not reasoning about yesterday's contract.
05
Working out why an answer looks stale
Check the cache statistics, and clear just that project instead of restarting the server.
8 tools
Listed in project docs. Your client may show a different list.
listCategorieslistCatInterfacessearchInterfacesgetInterfaceDetailrefreshCacheclearProjectCachegetCacheStatsBEFORE YOU INSTALL
What to know first
Tools you get
8 tools named in the project's documentation.
Requires
Java Environment JDK 21+
Where it runs
The documented client runs the server on your machine.
INSTALLATION
Connect your client
Server setup
Prerequisites — choose one: Java Environment: JDK 21+ and Maven 3.6+, or Docker Environment: Docker and Docker Compose
Clone the repository:
TERMINAL
git clone https://github.com/yyykf/yapi-mcp-server.git
cd yapi-mcp-serverSet your Yapi URL and the yapi.project-tokens map (project ID to token) in src/main/resources/application-mcp.yml: vim src/main/resources/application-mcp.yml
Method 1 (Java) — build and run the jar:
TERMINAL
mvn clean package
java -jar target/yapi-mcp-server-0.0.1-SNAPSHOT.jarMethod 2 (Docker) — run this instead of the two Java commands:
TERMINAL
docker-compose up -dAdd the configuration under MCP Clients to your Cursor MCP settings file (mcp.json).
Check that the server is up:
TERMINAL
curl http://localhost:8888/actuator/healthMCP Clients
Cursor
CURSOR · JSON
{
"mcpServers": {
"yapi": {
"url": "http://127.0.0.1:8888/sse"
}
}
}
