Api users list

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is covered. The description adds nothing useful beyond a vague claim about "optimized data" in the serializer context; it does not explain pagination (limit/offset/max_pages), default ordering, or result shape.

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?

The single sentence is short but entirely wasted — it is an internal code comment with no actionable content for tool selection or invocation. Brevity here reflects under-specification rather than conciseness.

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 an 18-parameter list endpoint with no output schema and no parameter documentation, the description supplies nothing an agent needs. Filter semantics, pagination behavior, and return format are all undocumented.

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?

Eighteen parameters with 0% schema description coverage, and the description explains none of them. Fields like exclude_current, keep_local_login, representative__entity, is_applied_control_owner and max_pages are entirely opaque to an agent, which cannot infer semantics or formats from either source.

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 restates an internal implementation detail ("Override the list method to inject optimized data into the serializer context") rather than telling the agent what the tool does. It never states that it lists/searches user accounts, nor what entity is returned. Only the tool name and title hint at the resource.

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 versus alternatives such as ciso_assistant_api_users_retrieve, ciso_assistant_api_users_object_retrieve, or ciso_assistant_api_user_groups_list. No prerequisites, no exclusions, no context.

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