snapshot_instance

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

The description discloses the prerequisite (stopped instance) and the action, but does not elaborate on behavioral traits such as whether snapshots can have duplicates, if it overrides existing snapshots with same name, or any error conditions. With no annotations, more detail would improve transparency.

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 concise: a single sentence defining the purpose, followed by a bulleted list of parameters. Every sentence is necessary and 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?

The description covers the core function and parameter semantics. However, it omits details about error conditions (e.g., instance not stopped, snapshot name already exists) and any post-conditions (e.g., snapshot list updated). Given the complexity (simple tool with output schema), it is adequate but not thorough.

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 provides basic semantics for each parameter (instance: the name; name: optional name; comment: optional comment), which compensates for the 0% schema description coverage. However, it lacks constraints like uniqueness, allowed characters, or whether name defaults to automatic naming.

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 (take snapshot) and the target (stopped Multipass instance). It includes a prerequisite (stopped state) which helps differentiate from other snapshot-related tools like restore_instance or list_snapshots, but does not explicitly name alternatives.

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 only for stopped instances, which is a key guideline. However, it does not provide explicit when/why to use this tool over alternatives (e.g., clone_instance for running instances) or any exclusions.

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