yuque_delete_doc

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

The description explicitly states 'requires confirmation', which is a safety-relevant behavioral trait not obvious from the schema alone. However, with no annotations provided and this being a destructive operation, it does not disclose whether deletion is permanent, irreversible, or has side effects, leaving a significant transparency 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, concise sentence that front-loads the action and identifies key parameters. Every word contributes value, with no filler or redundancy.

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?

For a destructive tool with no annotations, no output schema, and a 0% parameter description coverage, this minimal description is insufficient. It does not explain the confirmation flow, the role of confirm_text, or what happens after deletion. Compared to similarly scoped tools, it leaves too much unstated.

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 0%, so the description must compensate. It explains 'namespace' and 'slug/doc_id' as identifiers, and 'requires confirmation' hints at the confirm parameters, but it does not clarify the meaning of 'confirm_text' or explain which of slug/doc_id is required. The description adds partial semantics but fails to cover all five parameters adequately.

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 uses a specific verb ('Delete') and clearly identifies the resource ('Yuque doc') plus the key identifiers ('by namespace and slug/doc_id'). This distinguishes it from sibling delete tools like yuque_delete_repo and yuque_delete_group, making the purpose unmistakable.

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 clearly implies usage when the agent needs to delete a Yuque doc, but provides no explicit guidance on when not to use it or mention of alternatives (e.g., using update for reversible changes). The context is sufficient to know it is the right tool for deletion, but it lacks exclusions or alternatives.

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