Void traceability event

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

Annotations declare readOnlyHint=false and destructiveHint=true; the description adds real nuance beyond that by explaining history keeps every revision and the record is retained while dropping out of totals. It still omits permission requirements and the concurrency/idempotency implications of expected_revision and request_key.

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 short sentences, action first, consequence second, with no filler. Every clause contributes either the operation or its retention semantics.

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 mutating tool with 5 undocumented parameters, no output schema, and no schema descriptions, the definition is too thin. It clarifies the lifecycle semantics but leaves an agent unable to infer idempotency, concurrency, or scoping behavior needed to call it 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?

Schema description coverage is 0% across 5 parameters, so the description carries the full explanatory burden, yet it only alludes to "reason". The idempotency key (request_key), optimistic-concurrency guard (expected_revision), and the farm_id/event_id scoping are never explained.

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?

States a specific verb ("Void") and resource (a typed traceability event) plus the required input ("with a reason"). It implicitly contrasts with hard deletion by noting the record is not erased, but it never names or distinguishes itself from close siblings such as correct_traceability_event or delete_record.

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?

Usage is only implied: "leaves ordinary totals without erasing the record" hints that this is the right call when an event should stop counting but stay auditable. There is no explicit when-to-use, when-not-to-use, or alternative (e.g., correct_traceability_event) to guide selection.

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