wafeq_payslips_download_retrieve

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

Annotations already declare readOnlyHint and idempotentHint, and the description reinforces this with 'Nothing is modified.' It goes beyond annotations by specifying the return shape: base64-encoded PDF bytes, size, and content type. It does not discuss auth or rate limits, but those are not necessary for a straightforward read-only download.

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 short, front-loaded with a keyword summary, and puts the return behavior last. The middle sentence 'Endpoint for downloading a PDF of the payslip' is redundant with the first line and title, preventing a perfect score.

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 one-parameter read-only PDF download with no output schema, the description is complete: it states the resource, endpoint, required id, return format, and non-mutating behavior. An agent has everything needed to invoke it correctly.

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 has a single string `id` with no description and 0% coverage, but the endpoint line 'GET /payslips/{id}/download/' supplies the missing semantics: `id` is the payslip identifier and is used as a URL path parameter. It could be more explicit about the id's source/format, but the meaning is recoverable.

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 payslip PDF'), states the REST endpoint, and specifies the response is a PDF. This distinguishes it from sibling payslip operations like wafeq_payslips_retrieve, update, and destroy, and from other PDF download endpoints.

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 endpoint and 'Download payslip PDF' make it clear when to use the tool: whenever the PDF version of a payslip is needed. It does not explicitly contrast with wafeq_payslips_retrieve or state when not to use it, but the context is clear and the lack of exclusions is minor for such a specialized endpoint.

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