list_snapshots

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

With no annotations provided, the description carries full burden but offers minimal behavioral insight. It states it's a list operation but doesn't cover pagination, sorting, error conditions, authentication needs, or rate limits. The description doesn't contradict annotations (none exist), but it's insufficient for a tool with potential complexity.

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 appropriately concise with two sentences that directly state the purpose and parameter meaning. It's front-loaded with the core functionality, though the 'Args:' section could be integrated more smoothly.

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 1 parameter, 0% schema coverage, and an output schema (which reduces need to describe returns), the description is minimally adequate. It covers the basic purpose and parameter meaning but lacks behavioral details and usage context that would help an agent operate effectively.

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 0%, but the description adds basic semantics for the single parameter 'vmid' by explaining it's 'The numeric ID of the VM or container.' This provides context beyond the schema's type/requirement info, though it doesn't detail format constraints or examples.

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 all snapshots') and resource ('for a VM or container'), making the purpose immediately understandable. However, it doesn't differentiate from sibling tools like 'list_backups' or 'list_containers' beyond mentioning snapshots specifically.

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?

No guidance is provided on when to use this tool versus alternatives. It doesn't mention prerequisites, context for selecting this over other list tools, or relationships with sibling tools like 'create_snapshot' or 'delete_snapshot'.

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