wafeq_credit_notes_download_retrieve

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

Annotations already mark the operation read-only, idempotent, and non-destructive, and the description reinforces this with 'Nothing is modified.' It adds useful behavioral detail beyond the annotations by specifying the response format: base64-encoded PDF bytes with size and content type.

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 core information is presented early and the description is short, but it repeats the same point multiple times: the first header line, the sentence 'Download credit note PDF', and 'Endpoint for downloading a PDF of the credit note' all convey the same meaning. The unique return-format detail is helpful, but redundancy reduces efficiency.

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 one-parameter tool with no output schema, the description covers the essential aspects: what it does, the endpoint path, the response format, and the non-mutating nature. It is complete enough for an agent to call it correctly, though it could slightly improve by explicitly defining the 'id' parameter.

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?

The schema only defines 'id' as a string with no description, and the description does not explicitly explain that 'id' is the credit note identifier. However, the endpoint path '/credit-notes/{id}/download/' and the tool name make the meaning inferable, so the description partially compensates for the 0% schema coverage.

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 states a specific verb ('download'), resource ('credit note'), and output ('PDF'), and includes the exact endpoint path. This clearly distinguishes it from retrieval endpoints like wafeq_credit_notes_retrieve and from other document-download siblings such as wafeq_invoices_download_retrieve.

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 clearly signals that this tool is for downloading a PDF version of a credit note, which gives an agent the context needed to choose it when a PDF document is required. It does not explicitly name alternatives or state when not to use it, so it stops short of a full 5.

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