Api contracts list

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

Annotations already declare readOnly, idempotent, openWorld, and non-destructive, and the description does not contradict them. However, it adds no useful behavioral context for the caller: 'inject optimized data into the serializer context' is an internal detail that does not clarify what is returned, whether results are paginated, or how the 22 filters behave.

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, but it is under-specified rather than effective. The space is wasted on an implementation note instead of front-loading the tool's actual purpose and key usage context.

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 22 mostly undocumented optional parameters, no output schema, and no explanation of pagination or filtering, the definition is wholly inadequate for correct invocation. An agent cannot tell what filters exist, how to paginate, or what the response shape will be.

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% across 22 parameters (id, name, limit, offset, search, ordering, status, currency, dates, and many domain-specific filters). The description mentions none of them, so an agent has no semantics for any filter, pagination control, or ordering behavior.

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 Django 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. It never says the tool lists contracts; only the name/title convey that. This is closer to framework boilerplate than a purpose statement.

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 tool versus the numerous sibling contract endpoints (retrieve, object_retrieve, cascade_info, export_csv, etc.). No conditions, prerequisites, or exclusions are given.

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