Skip to main content
Glama
Sign In
YAPI MCP Server

YAPI MCP Server

by zhhbinn
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

yapi_import_data

Imports API documentation data into YAPI from formats like Swagger, Postman, HAR, or JSON to manage and organize interface details across projects.

Instructions

导入接口数据到 YAPI

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "type": "<type>",
      "json": "<json>"
    },
    "name": "yapi_import_data"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlNoYAPI 接口页面 URL（可选），如 https://yapi.xxx.com/project/1009/interface/api/108375，会自动解析出项目 ID、接口 ID 等参数
projectNo项目 ID（可选，不传则使用默认项目）
typeYes导入类型，如：swagger、postman、har、json
jsonYes导入的 JSON 数据
mergeNo合并模式：normal(普通)、good(智能合并)、merge(完全覆盖)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.6/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries full burden but lacks behavioral details. It doesn't disclose if this is a mutating operation (likely yes), permission requirements, rate limits, or side effects (e.g., overwriting existing data). The merge parameter hints at conflict behavior, but the description doesn't elaborate.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence in Chinese, front-loading the core action. However, it could be more structured by briefly mentioning key parameters or use cases without adding bulk.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 5-parameter mutating tool with no annotations or output schema, the description is incomplete. It doesn't cover behavioral traits (e.g., idempotency, errors), output expectations, or how it differs from sibling tools, leaving gaps for agent understanding.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema documents all parameters well. The description adds no parameter semantics beyond the tool name implying 'import' relates to 'json' and 'type' parameters. Baseline 3 is appropriate as the schema handles most details.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description '导入接口数据到 YAPI' (Import interface data to YAPI) states the action and target but is vague about scope and specifics. It doesn't differentiate from siblings like yapi_interface_add (which likely adds single interfaces) or clarify what 'interface data' entails (e.g., bulk imports from external formats).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool versus alternatives like yapi_interface_add (for single interfaces) or yapi_interface_save/up (for updates). It mentions importing data but doesn't specify scenarios (e.g., initial setup, migration) or prerequisites (e.g., project existence).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools