yapi-mcp
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| DEBUG | No | Set to 1 to emit logs to stderr | |
| YAPI_TOKEN | Yes | Format projectId:tokenValue, from the YApi project Settings → token | |
| YAPI_BASE_URL | Yes | YApi host, e.g. http://yapi.example.com |
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 | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| yapi_list_projectsA | 列出当前 token 配置的 YApi 项目信息（项目 ID、名称、描述）。无参数。 |
| yapi_get_categoriesB | 获取指定项目的接口分类列表（分类 ID、名称，以及每个分类下的接口概要）。 |
| yapi_search_apisA | 在项目内按关键词搜索接口（匹配 title/path，可选按 method 过滤），返回接口列表。 |
| yapi_get_api_detailsA | 获取接口详细信息（请求参数、请求头、请求体类型与结构、响应体等）。 |
| yapi_save_apiA | 创建或更新 YApi 接口。带 api_id 走更新（/api/interface/up），不带走创建（/api/interface/add）。至少需提供 project_id 与 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 5 tools
Each tool targets a distinct operation: listing projects, retrieving categories, getting API details, saving APIs, and searching. There is no functional overlap; an agent can clearly distinguish them.
All tools follow a consistent 'yapi_verb_noun' pattern using snake_case, with clear and descriptive verbs (get, list, save, search). No mixing of conventions.
Five tools is well-scoped for a YApi integration, covering the core interactions: project listing, category browsing, API details, creation/updating, and searching. Not excessive or insufficient.
Core CRUD and search are present, but a delete API tool is missing, which could be a gap for lifecycle management. However, the main workflows (discover, read, create/update) are covered.