brc_delete_sales_entry

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 behavior. It explains the preflight check, the need for user confirmation, and that the first call returns a preview. It lacks details on authorization requirements or irreversibility, but the core deletion workflow is transparently documented.

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 three sentences with no redundancy. The first sentence immediately states the tool's purpose, and subsequent sentences efficiently explain the required workflow. Every sentence adds value.

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's complexity (two-step deletion with confirmation) and the lack of an output schema, the description adequately explains what to expect (preview, confirmation_required, retry). It does not detail the preview content or timestamp handling, but overall provides enough context for an AI to use the tool correctly.

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?

The schema covers 3 of 4 parameters with descriptions (75% coverage). The tool description adds process context for confirmWrite, explaining its role in the two-step workflow. However, confirmDelete is not mentioned in the description and only has a default value, so some gap remains.

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 states the action ('Deletes'), the resource ('BRC sales entry'), and the method ('by id using timestamp confirmation'). It clearly differentiates from sibling delete tools by specifying the two-step confirmation process, which is unique to this tool.

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 explicit step-by-step instructions: first call without confirmWrite to get a preview and confirmation_required, then retry with confirmWrite after user confirmation. It warns against passing preflight as confirmation and clarifies that confirmWrite must only be true after explicit user confirmation.

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