wafeq_payments_download_retrieve

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

Annotations already mark it read-only/idempotent, and the description adds concrete behavioral detail: the response is base64-encoded PDF bytes plus size and content type, and 'Nothing is modified.' This goes beyond the structured hints and gives the agent a realistic picture of side effects and return format.

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?

Key facts (read-only, PDF, resource, endpoint) are front-loaded in the first line. However, 'Download payment PDF' and 'Endpoint for downloading a PDF of the payment' restate the same idea, so not every sentence earns its place.

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 single-parameter read-only download tool, the definition covers purpose, endpoint, safety, and response shape, so an agent has enough to select and invoke it correctly. No output schema exists, so the explicit mention of base64-encoded content, size, and content type fills that gap. The lack of explicit routing to sibling alternatives is minor given the clear resource path.

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 only parameter 'id' has no schema description (0% coverage), but the path template GET /payments/{id}/download/ and 'payment PDF' make it clear id refers to the payment identifier. The description compensates for the schema gap by grounding the parameter in the resource context.

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?

States an explicit verb ('Download'), a specific resource ('payment PDF'), and the exact endpoint path. The 'Payments' qualifier distinguishes it from sibling download tools for payslips, invoices, bills, etc. No ambiguity about what it does.

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 makes clear it is the endpoint for obtaining a payment's PDF via GET /payments/{id}/download/, so an agent can route payment-PDF requests here. It does not explicitly name alternatives or exclusions, but the resource-specific context is sufficient for selection among the sibling download tools.

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