Api compliance assessments xlsx retrieve

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

The description claims the endpoint allows assessments to be 'edited', while the annotations declare readOnlyHint=true, destructiveHint=false and idempotentHint=true. That is a direct contradiction of the declared safety profile. Nothing about the XLSX payload, file generation cost, or permissions is disclosed.

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?

It is a single short sentence with no padding, so it is concise. But brevity here comes from boilerplate rather than economy, and it is not front-loaded with the actual operation or output format.

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 no-output-schema export endpoint, the description should state the return format, filename/stream behavior, and required id semantics. Instead it supplies none of these and misdescribes the operation as editable, leaving the agent unable to invoke it confidently.

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 coverage is 0% – the single required 'id' parameter has no description. The description does not mention the id at all, let alone whether it identifies the assessment to export, so the agent gets no meaning beyond the schema's bare string type.

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 the resource (compliance assessments) but says only that it 'allows compliance assessments to be viewed or edited', which is generic DRF-boilerplate. It never states that this endpoint returns an XLSX export (the distinguishing feature in the tool name, adjacent to siblings like compliance_assessments_export_retrieve and compliance_assessments_cyfun_xlsx_retrieve), so an agent cannot tell what it actually produces.

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?

No indication of when to call this versus the many sibling compliance-assessment retrieval/export tools (csv, cyfun_xlsx, action_plan_xlsx, word_report, export). 'Viewed or edited' gives no selection criteria at all.

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