pve_get_snapshots

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

The description discloses the default behavior when vm_name is omitted ('all VMs'), which is valuable. However, it doesn't discuss error cases, permissions, or return payload details, which is expected given no annotations. The core behavior is transparent enough for a simple list 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?

A single sentence that is front-loaded and information-dense, with zero filler. Every word adds value.

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 list operation with one optional parameter and an output schema, the description covers the essential usage. It could mention potential errors or require more detail, but the low complexity makes this sufficient.

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?

The description explains the vm_name parameter's effect: filter by VM name or omit for all VMs. This compensates for the schema's 0% coverage, clarifying the parameter's optionality and semantics effectively.

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 tool lists Proxmox-level snapshots for a VM, with a scope qualifier ('or all VMs if no name given'). This specific verb-resource combination distinguishes it from sibling tools that target nodes, storage, or VM configurations.

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 clear context on when to use this tool: to retrieve snapshots for a specific VM or all VMs based on vm_name. It doesn't explicitly name alternatives or exclusions, but the scope guidance is sufficient and unambiguous.

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