pdm_roles_list

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

With no annotations provided, the description carries full burden. It declares 'READ-ONLY' and 'No state change', and mentions 'Returns a list of role dicts.' This adequately conveys the behavioral traits of a safe, read-only operation.

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 extremely concise with three short sentences, each carrying essential information. Purpose, behavior, usage guidance, and config requirement are all front-loaded without any extraneous text.

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 a simple read-only list tool with an output schema, the description covers all necessary context: purpose, safety, alternative tool, and configuration. Nothing is missing.

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 100% and the schema's parameter description for 'proximo_target' is thorough. The tool description adds no additional semantics beyond that, 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?

The description clearly states 'READ-ONLY: list PDM's own roles and their privileges' with a specific verb and resource. It explicitly distinguishes from sibling tool 'pve_roles_list' by noting it is not for managed remote's roles.

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 says 'No state change' and explicitly provides an alternative tool: 'For a managed PVE cluster's roles instead of PDM's own, use pve_roles_list.' It also mentions the config requirement 'Needs PROXIMO_PDM_* config.'

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