delivery_notes_pdf

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint=false. The description adds useful behavior beyond annotations: the return is base64-encoded PDF binary data, the document must be issued/converted, and VAT/prices can be hidden.

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 front-loaded sentences with no wasted text. The core action, return format, status prerequisite, and optional flags are all presented efficiently.

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 read-only PDF download tool with no output schema, the description covers the critical return format, the document-status prerequisite, and the optional visibility controls. The schema and annotations already supply the remaining parameter and safety details.

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 100%, so all four parameters are already documented in the schema. The description adds rationale for hideVat/hidePrices (simplified delivery documents) but does not add meaning for companyId beyond what the schema provides.

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 gives a specific verb and resource: "Download the PDF for a delivery note." The resource is clearly differentiated from sibling PDF tools such as invoices_pdf, receipts_pdf, and proforma_invoices_pdf.

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?

It states a clear prerequisite: the delivery note must be in issued or converted status. It also explains optional simplification via hiding VAT or prices, but it does not explicitly name alternative tools like delivery_notes_email or describe when not to use this tool.

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