restore_snapshot

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

With no annotations provided, the description fully explains the behavioral aspects: what is reverted, what persists, and error handling. It is transparent about the partial restore of state.

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 with four sentences, each adding essential information. It is front-loaded with the main purpose and efficiently covers scope and error behavior.

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 has only one parameter and an output schema exists, the description covers all necessary context: what is restored, what is not, persistence of execute() calls, and error condition. It is complete for a simple restore 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?

The schema has 0% description coverage for the 'name' parameter. The description adds that the snapshot name must exist and will raise an error otherwise, providing necessary context beyond the schema.

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 restores geometric state from a previously saved snapshot, specifying exactly what is restored (current_shape and show() registry) and what is not (Python variable namespace). This distinguishes it from sibling tools like save_snapshot and diff_snapshot.

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 explains the scope of restoration, noting that execute() calls remain in scope, which helps decide when to use this tool. However, it does not explicitly state when not to use it or suggest alternatives like reset.

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