bokio_download_credit_note

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

Annotations only declare readOnlyHint and openWorldHint, so the description's statement that it returns the written path and byte count is genuine added value — especially since there is no output schema to carry that. It does not restate the schema's no-overwrite rule or mention error behavior, but it adds real context beyond the structured fields.

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?

Two short sentences, action and destination front-loaded, return values second. No filler or redundancy.

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 simple file-download tool with a fully documented schema, the description covers purpose, target, and outcome. The only material gap is what happens for a draft/unpublished credit note, which the word "published" hints at but never explains.

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% and already documents savePath semantics, the BOKIO_COMPANY_ID default, and the not-found behavior for unknown creditNoteId. The description only echoes savePath's role, adding nothing the schema does not already say, so the baseline 3 applies.

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 names a specific verb and resource ("Download a published credit note as a PDF file") plus the destination, which clearly separates it from bokio_get_credit_note (metadata fetch) and bokio_list_credit_notes. It lacks only an explicit contrast with sibling download tools like bokio_download_invoice, which differ by resource but are interchangeable in shape.

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 word "published" implies a precondition (drafts presumably cannot be downloaded), but this is stated as an adjective rather than a rule. No guidance is given on when to choose this over bokio_get_credit_note or bokio_download_invoice, and no failure conditions are described.

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