Api requirement assessments list

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=true, so safety is covered externally. The description adds no caller-relevant behavior (pagination, filtering semantics, result shape) and merely references an internal serializer optimization, which is not actionable information for an agent.

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, so there is no bloat, but the one sentence that exists is spent on an internal implementation detail rather than front-loading anything the caller needs. Brevity here reflects under-specification, not 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?

A 20-parameter listing endpoint with no output schema, no parameter documentation, and no annotation-adjacent explanation is left almost entirely undefined. An agent cannot determine what it returns or how the filters combine from this description.

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 20 parameters with 0% description coverage — names like 'extended_result', 'requirement__assessable', 'compliance_assessment__perimeter__name', and 'max_pages' are ambiguous — and the description explains none of them. This is the maximum gap case where the description had to compensate and did not.

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 is an internal implementation note ('Override the list method to inject optimized data into the serializer context') rather than a statement of what the tool does for a caller. Only the title hints that it lists requirement assessments; the description itself never names the resource, scope, or return content.

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 list endpoint versus the many sibling read endpoints such as requirement_assessments_result_retrieve, requirement_assessments_extended_result_retrieve, or compliance_assessments_requirements_list_retrieve. Nothing about prerequisites or exclusions is stated.

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