frappe_delete_document

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

No annotations provided, so description carries full burden. It discloses destructive behavior ('Delete') and a required flag ('confirm=true'). However, it doesn't mention if deletion is soft or hard, or what happens to related records, which would be useful. Still, it's better than average.

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?

Two concise sentences with no wasted words. Front-loaded with the main action, then essential conditional guidance.

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 delete tool, the description covers purpose, usage rules, and alternatives. It lacks explanation of return values or side effects (e.g., whether the document is permanently removed or just archived), but given no output schema, this is a minor gap.

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 has 3 parameters with 0% coverage in description. The description adds value by noting that 'confirm' must be true, but it does not explain 'doctype' or 'name'. Given low schema coverage, description should compensate more. Baseline is 3, so score is appropriate.

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?

Clearly states 'Delete a document' (verb+resource). Also distinguishes from a sibling tool for firearms/Items, which is helpful for selection.

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?

Explicitly requires 'confirm=true' and provides an alternative tool for specific document types (firearms/Items) with a reason (preserves audit trail). This gives clear when-to-use and when-not-to-use guidance.

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