create_purchase_payment_line

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

With no annotations, the description carries the full burden. It discloses that the tool only constructs the payload and does not validate fields. However, it omits details about side effects, idempotency, error conditions, permissions, or reversibility, leaving gaps.

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, each serving a distinct purpose: stating the action, providing context on line vs. document settlement, and warning about caller responsibility. No extraneous 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?

Given 10 parameters and no annotations, the description captures the core concept and responsibility. However, it omits prerequisites (e.g., payment must exist), output details (though output schema exists), and potential pitfalls, leaving the agent partially underinformed.

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 100%, so baseline is 3. The description adds value by clarifying that payable_id is a line ID and that field values are caller responsibility. However, it does not elaborate beyond the schema, which already describes each parameter sufficiently.

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 clearly states the action (settle a purchase document line against a payment) and the resource (payment line). It explicitly distinguishes from sales receipts, which settle whole documents, thereby differentiating from sibling tools like create_sales_receipt_line.

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 when to use (to link a payment to a payable line) and contrasts with sales receipts. It notes that field validation is the caller's responsibility and that only the payload is built. However, it does not list explicit alternatives or when not to use.

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