pbs_snapshots_list

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

With no annotations provided, the description carries the full burden. It explicitly states the operation is read-only and lists returned metadata fields, but does not disclose pagination, ordering, or potential limitations. It is sufficient for a simple list tool but lacks depth.

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 two sentences, front-loading the action and read-only nature, then listing return fields and filters concisely. Every word adds value, with no redundancy.

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 and the presence of an output schema, the description covers the essential aspects—purpose, filters, and return fields. It lacks detail on parameter formats but is otherwise complete for a list operation.

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 low (20%), but the description adds meaning by listing three filter parameters and providing an example for backup_type (vm/ct/host). However, it does not explain ns or backup_id formats, and proximo_target is described only in the schema. The description partially compensates but is not comprehensive.

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 action ('List') and resource ('backup snapshots in a PBS datastore'), includes scope ('with optional filters'), and explicitly notes it's read-only. It distinguishes itself from sibling tools like pbs_snapshot_delete by focusing on listing and metadata retrieval.

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 implies usage when listing snapshots but does not specify when to avoid using this tool or mention alternatives. No guidance is given on when to use it versus other related tools (e.g., pbs_datastores_list or pbs_snapshot_*).

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