pdm_users_list

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

No annotations are provided, so the description carries full burden. It mentions 'list all PDM users' (a read operation) and a config requirement, but does not disclose whether the operation is safe, idempotent, or has any side effects, rate limits, or pagination behavior.

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 description is concise with two short lines. The purpose is front-loaded via the DIAGNOSE prefix and explicit statement. It could be slightly better structured, but it is efficient without extraneous words.

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?

Given the presence of an output schema, the description does not need to explain return values. However, it lacks info on pagination, ordering, or any filtering beyond the include_tokens option. Config requirements are mentioned, but overall completeness is low for a list tool.

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 coverage is 50% (only proximo_target has a description). The description adds meaning for include_tokens ('if True, include API token entries'), which is helpful. However, it does not elaborate on the other parameter beyond what the schema already states.

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 clearly states the verb 'list' and the resource 'all PDM users'. The DIAGNOSE (LOW) prefix further clarifies the context. It sufficiently distinguishes from sibling tools like pdm_resources_list or pdm_roles_list.

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?

The description includes a prerequisite ('Needs PROXIMO_PDM_* config'), which is useful. However, it does not indicate when to use this tool versus alternatives, nor does it provide any when-not-to-use guidance or comparisons with similar list tools.

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