yapi-create-interface

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.