yuque_delete_doc

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

With no annotations provided, the description carries the full burden of disclosing behavioral traits. It fails to mention whether deletion is permanent, if it is irreversible, what happens to associated data, or any error conditions. The phrase 'Delete a document' merely restates the tool's name without adding 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 a single sentence with zero wasted words. It is appropriately sized for the tool's simplicity, though it is minimal.

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 is a deletion operation with no output schema and no annotations, the description should mention side effects, permission requirements, or return values. It does none of these, leaving significant gaps for an agent to understand the full impact of invocation.

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 both repo_id and doc_id having descriptions. The tool description adds no additional parameter semantics, but the schema already documents the parameters clearly, so the description does not need to compensate.

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 'Delete a document' clearly states the action and resource. It distinguishes from sibling tools like get_doc, create_doc, and update_doc by specifying the delete operation, but it lacks any additional scope details such as 'from a repository'.

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, such as when a document should be permanently removed versus updated. It does not mention prerequisites like permissions or conditions, offering only the implied use case of deletion.

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