pbs_remotes_list

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

Discloses read-only nature, data sanitization (passwords never included, defensive stripping), and config dependency, compensating for the lack of annotations.

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 concise sentences, front-loaded with 'READ-ONLY', covering purpose, return type, security, siblings, and config requirements without waste.

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?

Comprehensive for a list tool with one optional parameter and output schema; covers all necessary context including return format, security, and config needs.

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 100%, so baseline 3 is appropriate. The description does not add any parameter-specific information beyond what the schema already provides.

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 remote sync-sources' with a specific verb and resource, and distinguishes from the sibling 'pbs_remote_get' for single remote config.

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 alternative: 'Use pbs_remote_get for one remote's config.' Also specifies 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.