pbs_roles_list

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

Declares READ-ONLY behavior and explains roles are a fixed enum, implying no mutation. No annotations provided, so description carries burden well. Could mention pagination or rate limits, but for a simple list tool this is sufficient.

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?

Three concise sentences, front-loaded with purpose and READ-ONLY flag. Every sentence adds value; no repetition or fluff.

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 tool's simplicity (1 param, output schema present), the description covers the purpose, behavioral constraints, and relationships to sibling tools completely.

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?

One parameter (proximo_target) with 100% schema description coverage. The description does not add additional meaning beyond the schema, so baseline of 3 is appropriate.

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?

Clearly states 'READ-ONLY: list PBS's built-in roles' with specific verb (list) and resource (PBS built-in roles). Distinguishes from PVE roles by noting the fixed enum and lack of CRUD endpoints, and from other tools like pbs_acl_update.

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?

Provides explicit when to use (listing roles), when not (no create/update/delete for PBS roles), and alternative (pbs_acl_update for assignment). Also mentions config prerequisite (Needs PROXIMO_PBS_* config).

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