books_void_credit_note

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

With no annotations, the description must fully explain behavior, but 'Void a credit note' provides no detail on effects, reversibility, permissions, or post-void status. It merely restates the tool's name and is almost tautological.

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 extremely short, but it is under-specified rather than efficiently concise. It lacks any structural detail or context that would help an agent, resembling the 'Process' example.

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 one required parameter and no annotations or output schema, the description should compensate, but it leaves critical questions unanswered: what does voiding do, what are the prerequisites, and how does it differ from deleting a credit note? The tool is not adequately specified.

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 coverage is 0% and the description does not explain the creditnote_id parameter or its format. The only clue is the parameter name itself, which is minimal for correct invocation.

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 clear verb-resource pattern ('Void a credit note') specifying both action and target. However, it does not distinguish voiding from related operations like deletion or conversion, which is a gap given the many sibling credit-note tools.

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?

No guidance is provided on when to use this tool versus alternatives such as books_delete_credit_note or books_convert_credit_note_to_open. The description offers no usage context or exclusions.

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