Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type @ followed by the MCP server name and your instructions, e.g., "@YAPI MCP Server list all API interfaces for project 123"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
一个用于 YAPI 接口管理平台的 MCP (Model Context Protocol) 服务器，支持查询项目、接口列表、接口分类、接口详情，以及新增和修改接口等功能。
🔍 项目查询 - 获取项目信息和项目列表
📂 分类管理 - 查询接口分类、新增分类
📋 接口管理 - 查询接口列表、接口详情、新增接口、修改接口
🔐 Cookie 认证 - 通过邮箱密码登录自动获取认证
Related MCP server: Yapi Auto MCP Server
# 克隆项目
git clone https://github.com/W-Abel-jia/yapi-interface-mcp.git
cd yapi-interface-mcp
# 安装依赖
npm install
# 构建
npm run build在项目根目录创建 yapi-interface-mcp.config.json 文件：
{
"baseUrl": "http://your-yapi-server:3000",
"email": "your-email@example.com",
"password": "your-password"
}环境变量 | 说明 | 必填 |
| YAPI 服务器地址 | ✅ |
| 登录邮箱 | ✅ |
| 登录密码 | ✅ |
编辑 Claude Desktop 配置文件：
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
添加以下配置：
{
"mcpServers": {
"yapi": {
"command": "node",
"args": ["/path/to/yapi-interface-mcp/dist/index.js"],
"env": {
"YAPI_BASE_URL": "http://your-yapi-server:3000",
"YAPI_EMAIL": "your-email@example.com",
"YAPI_PASSWORD": "your-password"
}
}
}
}重启 Claude Desktop 即可使用。
如 Cursor、Windsurf、Cline 等，参考各客户端的 MCP 配置方式：
命令: node /path/to/yapi-interface-mcp/dist/index.js
环境变量: 配置 YAPI_BASE_URL 和认证信息
cd yapi-interface-mcp
npx @modelcontextprotocol/inspector node dist/index.js工具名称 | 功能描述 | 必需参数 |
| 获取项目信息 |
|
| 获取项目列表 | - |
| 获取项目的接口分类列表 |
|
| 获取指定分类下的接口列表 |
|
| 获取项目的所有接口列表 |
|
| 获取接口详情 |
|
| 新增接口 |
|
| 修改接口 |
|
| 新增分类 |
|
projectId: number - 项目IDprojectId: number - 项目IDcatid: number - 分类IDprojectId: number - 项目IDid: string - 接口ID（数字格式）title: string - 接口标题
path: string - 接口路径，如 /api/user
method: "GET" | "POST" | "PUT" | "DELETE" | "HEAD" | "OPTIONS" | "PATCH"
catid: number - 分类ID
desc?: string - 接口描述
status?: "done" | "designing" | "dev" | "undone"
req_body_type?: "form" | "json" | "file" | "raw" | "text"
req_body_other?: string - 请求体 JSON Schema
req_body_form?: Array<{name, type, required, desc}>
req_headers?: Array<{name, value?, required, desc?}>
req_params?: Array<{name, desc?}>
req_query?: Array<{name, required, desc?}>
res_body_type?: "json" | "raw" | "text"
res_body?: string - 响应体 JSON Schemaid: number - 接口ID
...其他参数同 yapi-create-interface（均为可选）name: string - 分类名称
project_id: number - 项目ID
desc?: string - 分类描述# 安装依赖
npm install
# 开发模式（监听文件变化）
npm run dev
# 构建
npm run build
# 运行
npm start安全性 - 配置文件 yapi-interface-mcp.config.json 包含敏感信息，请勿提交到版本控制系统。已添加到 .gitignore。
网络访问 - 确保 MCP 服务器能够访问 YAPI 服务器。
MIT
新增 YAPI 接口分类
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | 分类名称 | |
| project_id | Yes | 项目ID | |
| desc | No | 分类描述 |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden of behavioral disclosure. '新增' implies a write operation, but the description doesn't state permissions required, whether this is idempotent, what happens on duplicate names, or what the response looks like. For a creation tool with zero annotation coverage, this is a significant gap.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient phrase in Chinese ('新增 YAPI 接口分类') that directly states the tool's purpose with zero wasted words. It's appropriately sized and front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given this is a creation tool with no annotations and no output schema, the description is incomplete. It doesn't explain what the tool returns (e.g., the new category ID), error conditions, or behavioral nuances. The context signals indicate moderate complexity (3 parameters, 2 required), but the description lacks necessary details for safe and effective use.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all three parameters (name, project_id, desc) with descriptions in Chinese. The tool description adds no additional parameter information beyond what's in the schema, meeting the baseline of 3 when schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description '新增 YAPI 接口分类' clearly states the action (新增/create) and resource (YAPI 接口分类/YAPI interface category) in Chinese. It's specific about what the tool does, though it doesn't explicitly differentiate from siblings like 'yapi-create-interface' which creates interfaces rather than categories.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing a project ID), exclusions, or relationships to sibling tools like 'yapi-get-categories' for listing categories or 'yapi-create-interface' for creating interfaces within categories.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
新增 YAPI 接口
| Name | Required | Description | Default |
|---|---|---|---|
| title | Yes | 接口标题 | |
| path | Yes | 接口路径，如 /api/user | |
| method | Yes | 请求方法 | |
| catid | Yes | 分类ID | |
| desc | No | 接口描述 | |
| status | No | 接口状态 | |
| req_body_type | No | 请求体类型 | |
| req_body_other | No | 请求体 JSON Schema | |
| req_body_form | No | 表单字段列表 | |
| req_headers | No | 请求头列表 | |
| req_params | No | 路径参数列表 | |
| req_query | No | Query 参数列表 | |
| res_body_type | No | 响应体类型 | |
| res_body | No | 响应体 JSON Schema |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. '新增 YAPI 接口' only indicates this is a creation operation but provides no information about permissions required, whether this is a mutating/destructive operation, rate limits, error conditions, or what happens on success. For a complex creation tool with 14 parameters, this is completely inadequate behavioral transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
While technically concise (only 4 Chinese characters), this is a case of under-specification rather than effective conciseness. The single phrase doesn't provide enough information to be helpful, and every description should earn its place - this one doesn't. It's too brief to be useful for tool selection or invocation.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
This is a complex creation tool with 14 parameters, no annotations, and no output schema. The description provides minimal information about what the tool does and nothing about behavior, usage context, or expected outcomes. Given the complexity and lack of structured metadata, the description is completely inadequate and fails to provide the contextual completeness needed for effective tool use.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with all 14 parameters having descriptions in the schema. The tool description adds zero parameter information beyond what's already in the structured schema. According to the rules, when schema_description_coverage is high (>80%), the baseline is 3 even with no param info in the description, which applies here.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description '新增 YAPI 接口' (Add YAPI interface) is a tautology that essentially restates the tool name 'yapi-create-interface' in Chinese. It provides the basic verb ('新增' meaning create/add) and resource ('YAPI 接口' meaning YAPI interface), but doesn't distinguish this from sibling tools like 'yapi-update-interface' or provide any specificity about what kind of interface creation this performs.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides absolutely no guidance on when to use this tool versus alternatives. There's no mention of prerequisites, when this tool is appropriate versus 'yapi-update-interface', or any context about the relationship with sibling tools like 'yapi-create-category' or 'yapi-get-interfaces'. The agent must infer usage from the tool name alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
获取项目的接口分类列表
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | Yes | 项目ID |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden of behavioral disclosure. It states it 'gets' categories, implying a read-only operation, but doesn't specify if it requires authentication, has rate limits, returns paginated results, or what the output format is (e.g., list structure). For a tool with zero annotation coverage, this leaves significant gaps in understanding its behavior and constraints.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence in Chinese ('获取项目的接口分类列表') that directly states the tool's purpose without unnecessary words. It's front-loaded and appropriately sized for a simple retrieval tool, with zero wasted content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's simplicity (one parameter, no annotations, no output schema), the description is incomplete. It lacks details on behavioral aspects (e.g., authentication needs, output format) and usage guidelines. While the schema covers the parameter, the overall context for an agent to effectively use this tool is insufficient, especially compared to siblings that might offer overlapping functionality.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description adds no parameter-specific information beyond what the schema provides. With 100% schema description coverage (the single parameter 'projectId' is documented as '项目ID'), the baseline is 3. The description doesn't elaborate on parameter semantics, such as where to find the projectId or valid ranges, but the schema adequately covers the basics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description '获取项目的接口分类列表' clearly states the action ('获取' meaning 'get') and resource ('接口分类列表' meaning 'interface category list'), specifying it retrieves categories for a project. It distinguishes from siblings like 'yapi-get-project' (gets project details) and 'yapi-get-interfaces' (gets interfaces), but doesn't explicitly contrast with 'yapi-get-interfaces-by-category', which might overlap in context. This is clear but lacks explicit sibling differentiation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing a valid projectId), exclusions, or comparisons to siblings like 'yapi-get-interfaces-by-category' (which might fetch interfaces filtered by category). Without such context, an agent must infer usage from the tool name and schema alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
获取接口详情，支持格式：数字ID
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | 接口ID，格式：数字ID |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It states the tool retrieves details but doesn't disclose behavioral traits such as whether it's read-only (implied by 'get'), authentication requirements, error handling, rate limits, or response format. For a tool with no annotations, this is a significant gap in transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise and front-loaded with the core purpose ('获取接口详情'), followed by a brief constraint ('支持格式：数字ID'). It uses only one sentence with no wasted words, though it could be slightly more structured for clarity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no annotations and no output schema, the description is incomplete. It doesn't explain what details are returned (e.g., interface name, parameters, responses) or any prerequisites. For a tool that likely returns structured data, this leaves the agent with insufficient context to use it effectively.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema description coverage is 100%, with the parameter 'id' fully documented in the schema as '接口ID，格式：数字ID' (interface ID, format: numeric ID). The description adds no additional meaning beyond this, merely restating the format. Baseline 3 is appropriate when the schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: '获取接口详情' (get interface details) with the specific resource '接口' (interface). It distinguishes from siblings like yapi-get-interfaces (list interfaces) and yapi-get-interfaces-by-category (filtered list). However, it doesn't explicitly mention the verb 'get' in English, though the meaning is clear from context.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage by specifying '支持格式：数字ID' (supports format: numeric ID), which suggests this tool is for retrieving details of a specific interface by its ID. It doesn't explicitly state when to use this vs. alternatives like yapi-get-interfaces (for listing) or yapi-update-interface (for modifications), leaving some ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
获取项目的所有接口列表
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | Yes | 项目ID |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It states the tool retrieves all interface lists, implying a read-only operation, but doesn't disclose behavioral traits such as pagination, rate limits, authentication needs, or response format. This is a significant gap for a tool with no annotation coverage.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence with zero waste, front-loaded with the core purpose. It's appropriately sized for a simple retrieval tool, making it easy to parse quickly.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's low complexity (one parameter, no output schema, no annotations), the description is minimally complete but lacks depth. It covers the basic purpose but misses behavioral details like output structure or error handling, which are important for a tool with no annotations or output schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% description coverage, with the single parameter 'projectId' documented as '项目ID'. The description doesn't add meaning beyond this, as it doesn't explain parameter usage or constraints. Baseline score of 3 is appropriate since the schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description '获取项目的所有接口列表' clearly states the action (获取/获取) and resource (接口列表), specifying it retrieves all interfaces for a project. It distinguishes from siblings like yapi-get-interface (singular) and yapi-get-interfaces-by-category (filtered by category), though not explicitly named. It avoids tautology by not merely restating the tool name.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage when needing all interfaces for a project, but lacks explicit guidance on when to use this vs. alternatives like yapi-get-interfaces-by-category or yapi-get-interface. No exclusions or prerequisites are mentioned, leaving usage context inferred rather than clearly defined.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
获取指定分类下的接口列表
| Name | Required | Description | Default |
|---|---|---|---|
| catid | Yes | 分类ID |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden of behavioral disclosure. It describes a read operation (获取/get) but doesn't specify whether it's paginated, the format of the returned list, error conditions, or any rate limits. For a list operation with zero annotation coverage, this leaves significant gaps in understanding how the tool behaves.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, clear sentence in Chinese that directly states the tool's purpose without any unnecessary words. It is front-loaded and efficiently communicates the core functionality, making it highly concise and well-structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (a filtered list operation), lack of annotations, and no output schema, the description is incomplete. It doesn't explain the return format (e.g., list structure, fields), pagination, error handling, or how it differs from sibling tools. For a tool with no structured behavioral data, the description should provide more context to be fully helpful.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 1 parameter with 100% description coverage ('分类ID/category ID'), so the schema fully documents the parameter. The description adds no additional semantic information beyond implying the parameter is used for filtering, which is already clear from the schema. With 0 parameters needing extra explanation, a baseline of 4 is appropriate as the description doesn't detract but also doesn't add value.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description '获取指定分类下的接口列表' clearly states the action (获取/get) and resource (接口列表/interface list) with a scope (指定分类下/under specified category), which is adequate. However, it doesn't distinguish this tool from its sibling 'yapi-get-interfaces' (which presumably gets all interfaces without category filtering), leaving some ambiguity about when to use one versus the other.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives like 'yapi-get-interfaces' or 'yapi-get-interface'. It mentions the category scope but doesn't explicitly state that this is for filtered listing by category versus other listing methods, nor does it mention prerequisites or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
获取 YAPI 项目信息
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | Yes | 项目ID |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden of behavioral disclosure. The description only states it 'gets' information, implying a read-only operation, but doesn't disclose any behavioral traits such as authentication requirements, rate limits, error conditions, or what the response format looks like. For a tool with zero annotation coverage, this is insufficient.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence ('获取 YAPI 项目信息') that is front-loaded with the core action. There's no wasted text, making it appropriately concise. However, it could be more structured by including key details, but it earns high marks for brevity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's simplicity (1 parameter, 100% schema coverage) but lack of annotations and output schema, the description is incomplete. It doesn't explain what information is returned (e.g., project details, metadata) or any behavioral aspects. For a tool with no output schema, the description should compensate by describing return values, but it fails to do so.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% description coverage (the 'projectId' parameter is documented as '项目ID' - project ID), so the schema does the heavy lifting. The description adds no additional meaning beyond what the schema provides—it doesn't explain what a project ID is, where to find it, or provide examples. Baseline 3 is appropriate when schema coverage is high.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description '获取 YAPI 项目信息' (Get YAPI project information) states a clear verb ('获取' - get) and resource ('YAPI 项目信息' - YAPI project information), making the purpose understandable. However, it doesn't differentiate from sibling tools like 'yapi-get-project-list' which likely retrieves multiple projects versus this tool's single-project focus. The description is vague about what specific project information is retrieved.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives. It doesn't mention when to use 'yapi-get-project' (for single project details) versus 'yapi-get-project-list' (for listing projects) or other sibling tools. There's no context about prerequisites, exclusions, or appropriate scenarios for invocation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
获取 YAPI 项目列表
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the tool fetches a project list but doesn't add any context about permissions, rate limits, pagination, or response format. For a read operation with zero annotation coverage, this leaves significant gaps in understanding how the tool behaves.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence ('获取 YAPI 项目列表') that directly states the tool's purpose with zero waste. It's appropriately sized and front-loaded, making it easy to parse quickly.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's low complexity (0 parameters, no output schema, no annotations), the description is minimally adequate. It states what the tool does but lacks details on usage context, behavioral traits, or output, which are needed for a complete understanding despite the simple schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has 0 parameters with 100% schema description coverage, so the schema fully documents the absence of inputs. The description doesn't need to add parameter details, and it appropriately doesn't mention any. A baseline of 4 is applied since no parameters exist, and the description doesn't introduce confusion.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description '获取 YAPI 项目列表' clearly states the action ('获取' meaning 'get' or 'fetch') and resource ('YAPI 项目列表' meaning 'YAPI project list'), providing a specific verb+resource combination. However, it doesn't explicitly distinguish this tool from its sibling 'yapi-get-project' (which likely fetches a single project), missing full sibling differentiation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives. With siblings like 'yapi-get-project' (for a single project) and 'yapi-get-interfaces' (for interfaces), there's no indication of context, exclusions, or prerequisites for choosing this list-fetching tool over others.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
修改 YAPI 接口
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | 接口ID | |
| title | No | 接口标题 | |
| path | No | 接口路径 | |
| method | No | 请求方法 | |
| catid | No | 分类ID | |
| desc | No | 接口描述 | |
| status | No | 接口状态 | |
| req_body_type | No | 请求体类型 | |
| req_body_other | No | 请求体 JSON Schema | |
| req_body_form | No | 表单字段列表 | |
| req_headers | No | 请求头列表 | |
| req_params | No | 路径参数列表 | |
| req_query | No | Query 参数列表 | |
| res_body_type | No | 响应体类型 | |
| res_body | No | 响应体 JSON Schema |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden of behavioral disclosure. '修改' (modify) implies a mutation operation, but the description doesn't disclose any behavioral traits: it doesn't mention authentication requirements, rate limits, whether changes are reversible, what happens to unspecified fields, or the response format. For a complex update tool with 15 parameters, this minimal description leaves critical behavioral aspects undocumented.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise with just three Chinese characters. While this represents severe under-specification for such a complex tool, from a pure conciseness perspective it's maximally efficient with zero wasted words. Every character earns its place by conveying the core action, though it fails to provide necessary additional context.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (15 parameters, mutation operation, no output schema, no annotations), the description is severely incomplete. It doesn't explain what the tool returns, what permissions are needed, how partial updates work, or how it differs from sibling tools. The 100% schema coverage helps with parameters, but the description fails to provide the contextual information needed for an agent to use this tool effectively in practice.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema description coverage is 100%, with all 15 parameters well-documented in the input schema. The description adds no parameter information beyond what's already in the schema. According to the scoring rules, when schema coverage is high (>80%), the baseline score is 3 even with no parameter information in the description. The description doesn't compensate but doesn't need to since the schema is comprehensive.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description '修改 YAPI 接口' (Modify YAPI interface) is a tautology that essentially restates the tool name 'yapi-update-interface' in Chinese. It provides the verb 'modify' and resource 'YAPI interface', but doesn't specify what aspects can be modified or distinguish it from sibling tools like 'yapi-create-interface'. The purpose is clear at a basic level but lacks specificity and differentiation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives. There are multiple sibling tools for YAPI interfaces (create, get, update), but the description doesn't indicate this is for updating existing interfaces versus creating new ones, nor does it mention prerequisites like needing an interface ID. It offers no context about appropriate use cases or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Recent tool additions, removals, and schema changes observed during successful MCP inspections. Dates show when Glama detected each change.
v1.0.0yapi-create-categoryyapi-create-interfaceyapi-get-categoriesyapi-get-interfaceyapi-get-interfacesyapi-get-interfaces-by-categoryyapi-get-projectyapi-get-project-listyapi-update-interfaceEvery tool has a clearly distinct purpose with no ambiguity. The tools are organized around specific resources (categories, interfaces, projects) and actions (create, get, update), making it easy for an agent to select the right tool. For example, yapi-get-interfaces and yapi-get-interfaces-by-category serve different but complementary purposes without overlap.
All tool names follow a consistent pattern: 'yapi-' prefix, followed by a verb (create, get, update), then a noun (category, interface, project). This predictable structure enhances readability and makes the tool set easy to navigate. There are no deviations in naming conventions across the nine tools.
With 9 tools, the server is well-scoped for managing YAPI resources. Each tool earns its place by covering essential operations like listing, creating, and updating interfaces and categories, as well as retrieving project information. This count is appropriate for the domain without being overwhelming or insufficient.
The tool set provides strong coverage for core CRUD operations on interfaces and categories, and project listing. However, there are minor gaps, such as missing update and delete operations for categories and projects, which agents might need to work around. Overall, it supports key workflows but isn't fully comprehensive.
Unclaimed servers have limited discoverability.
If you are the server author, to access and configure the admin panel.
MCP server for generating rough-draft project plans from natural-language prompts.
MCP server for AI access to Swagger by SmartBear.
The Mercado Pago MCP Server implements the Model Context Protocol to provide AI agents and LLMs with access to Mercado Pago's APIs and tools within compatible development environments. It acts as an intermediary that translates Mercado Pago resources into executable functions (tools) that AI applications can invoke to perform actions and automate flows. The server simplifies integration, enables using documentation to implement or improve code, and optimizes operations through natural language interactions without manual implementations.
MCP server for building and testing AI agents with multi-model experimentation and insights.
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/W-Abel-jia/yapi-interface-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server
