YAPI MCP Server
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| YAPI_UID | Yes | Your YAPI user ID | |
| YAPI_TOKEN | Yes | Cookie token for authentication | |
| YAPI_BASE_URL | Yes | Your YAPI instance URL |
Instructions
Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.
This server publishes no instructions, or was last inspected before Glama recorded them.
Capabilities
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| yapi_get_projectB | Get project basic information including name, description, base URL, and environment configurations. |
| yapi_get_cat_menuB | Get the list of interface categories (folders) for a project. Returns category IDs, names, and descriptions. |
| yapi_list_interfacesB | List interfaces in a project with pagination. Returns basic info (ID, title, path, method, status) for each interface. |
| yapi_list_by_categoryB | List interfaces belonging to a specific category with pagination. |
| yapi_get_interfaceA | Get complete details of a single API interface including request parameters (headers, query, body), response body schema, description, and status. |
| yapi_get_full_menuA | Get all interfaces grouped by category for a project. Returns the complete category-to-interface hierarchy. Warning: may return large payloads for big projects. |
| yapi_get_by_urlA | Parse a YAPI page URL and fetch the corresponding data automatically. Supports project URLs (/project/{id}/interface/api), interface URLs (/project/{id}/interface/api/{interfaceId}), and category URLs (/project/{id}/interface/api/cat_{catId}). |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
TDQS
Scored across 7 tools
Each tool has a clearly distinct purpose: URL parsing, category listing, full hierarchy, single interface details, project info, listing by category, and general listing. No overlap.
All tools follow the pattern 'yapi_<verb>_<noun>', but 'yapi_get_by_url' deviates slightly from the direct resource naming of others (e.g., 'yapi_get_interface'). Overall consistent.
7 tools is well-scoped for a read-only API documentation server, covering project info, categories, full hierarchy, interface details, and multiple listing methods.
The surface covers core read operations; missing search by method/status or interface modification is acceptable for a read-only server. Minor gaps in filtering.