Api validation flows list

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so safety is covered. The description adds nothing behavioral — no report on pagination (limit/offset/max_pages), filtering, or result shape — just an internal serializer note. It does not contradict the annotations.

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?

A single short sentence, so there is no padding, but it is spent on implementation jargon rather than user-facing purpose. Brevity here reflects under-specification rather than discipline.

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 21-parameter list endpoint with no output schema and no annotations covering pagination or filtering demands substantive description. This provides none, so an agent cannot tell what a call returns, whether results are paginated, or how to filter — the definition is functionally incomplete.

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?

With 21 parameters at 0% schema description coverage, the description carries the full burden and provides nothing. Filter fields such as status, approver, policies, folder, search, ordering and max_pages are entirely undocumented anywhere, leaving the agent unable to construct a useful query.

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 'overrides the list method to inject optimized data into the serializer context' — a Django-internal implementation note, not a statement of what the tool does. An agent must infer from the name that it lists validation flows; the description neither names the resource nor distinguishes it from siblings like validation_flows_retrieve or validation_flows_object_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?

No when-to-use guidance, no prerequisites, and no mention of alternatives such as validation_flows_retrieve for a single record or the many other list endpoints. The agent is left to guess entirely from the tool name.

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