pbs_users_list

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

Declared READ-ONLY, lists returned fields, notes include_tokens behavior and secrets exclusion. Lacks mention of pagination or rate limits but covers key aspects.

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?

Two sentences, front-loaded with READ-ONLY and purpose, no waste. Efficiently packs function, output, options, and sibling references.

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 output schema present, description sufficiently explains inputs and output shape. Mentions config requirement. Lacks details on sorting or limits, but adequate 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 covers both parameters (100%). Description adds value for include_tokens ('never secrets') and clarifies proximo_target selection. Baseline 3 with extra semantic detail.

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 'list all PBS users' with specific output fields. It distinguishes from siblings pbs_user_get and pbs_user_tokens_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?

Explicitly recommends alternatives for single user config or token listing. Provides configuration prerequisite (PROXIMO_PBS_* config).

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