Api compliance assessments compliance assessment csv retrieve

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

The description claims the endpoint allows assessments to be 'viewed or edited,' while annotations declare readOnlyHint=true and destructiveHint=false; a caller could reasonably infer a write path that does not exist. It also omits everything behaviorally relevant for an export tool: that the response is CSV content, its schema, and that it is scoped to a single record id.

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 one short sentence, but brevity here is under-specification rather than conciseness: the single sentence conveys no actionable information and is not front-loaded with the actual operation (CSV export by id).

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?

With no output schema and a 0%-covered input schema, the description needed to carry the full burden of explaining the CSV return, the id semantics, and the read-only nature. It does none of that and only supplies misleading boilerplate.

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 0%, so the single required 'id' parameter is undocumented in both the schema and the description. The description never explains that the id identifies the compliance assessment whose CSV is exported, nor its expected format (e.g., UUID).

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 says only that it is an 'API endpoint that allows compliance assessments to be viewed or edited,' which restates the generic DRF boilerplate rather than naming the actual operation. Nothing states that this endpoint returns a CSV export of a single compliance assessment, and it is indistinguishable from siblings such as compliance_assessments_xlsx_retrieve, word_report_retrieve, or export_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?

There is no guidance on when to use this CSV endpoint versus the many sibling export/report endpoints (xlsx, word report, action_plan_csv, export_retrieve). No prerequisites, no mention of what the CSV contains, and no exclusion of the 'edited' interpretation the sentence hints at.

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