billy_create_bank_payment

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

No annotations provided, so description bears full burden. It discloses the WRITE nature and the confirm:true requirement. Does not detail all side effects (e.g., data creation) but covers key behavioral trait.

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?

Three sentences: purpose, behavioral note, shape. Front-loaded with key info. Zero wasted words.

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?

Covers purpose, usage (confirm), and parameter shape. No output schema, but acceptable for a create mutation. Could mention return value (e.g., created payment ID) but not essential.

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 50%, but description compensates fully by specifying shape of bankPayment object including fields like entryDate, cashSide, cashAmount, etc. Adds substantial meaning beyond the schema's minimal description.

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 'Create a bank payment' and explains its use to mark invoices/bills as paid. Differentiates from sibling create tools like billy_create_bill and billy_create_invoice by specifying resource and context.

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 mentions the need for confirm:true to execute, separating dry-run from actual mutation. Says 'Used to mark invoices/bills as paid' but does not explicitly contrast with alternative payment methods or other tools.

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