create_credit_note

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

With no annotations provided, the description carries the full burden, and it delivers substantially: explains posting direction reversal (debit Income/credit A/R for customers; debit A/P/credit Expense for vendors), audit trail preservation, and the employee limitation with a GnuCash-specific rationale. Rich behavioral detail about what the post-time effect is.

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 well-organized with a clear workflow summary and per-parameter Args section, and front-loads the core purpose. However, it is fairly long with the detailed posting-direction accounting details and the embedded employee-reimbursement digression, somewhat stretching conciseness.

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?

Despite being a complex tool with 8 parameters and zero annotation coverage, the description covers purpose, workflow, posting mechanics, limitations, and per-parameter semantics thoroughly. The output schema exists so return values need not be described. Complete enough for an agent to use 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%, so the description fully compensates. It explains every parameter meaningfully: applies_to_invoice_id constraints (same owner, same currency, audit trail value, floating note option), currency inheritance rules, owner_type restrictions, and credit_note_id auto-generation from the shared counter. High value added beyond bare schema.

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?

Description clearly states the tool creates a credit note against a customer invoice or vendor bill, with specific verb and resource. It distinguishes from siblings like apply_credit_note and add_credit_note_entry by describing the full workflow, though it doesn't explicitly name those sibling alternatives.

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?

Provides clear workflow context: use add_credit_note_entry to add line items then post_invoice to post. Mentions settled by refund (pay_invoice) or netting (apply_credit_note), which contextualizes when this tool fits. Does not explicitly state when NOT to use it, but gives adequate usage framing.

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