bricks_restore_snapshot

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

With no annotations, the description carries full burden. It discloses the auto-backup creation, a key behavioral trait, but omits details on side effects (e.g., overwrites current page), permissions needed, or how to revert the auto-backup. For a restore tool, more transparency is required.

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?

Two sentences, front-loaded with the core action and resource, followed by key behavioral note and param flexibility. No redundant words; each sentence 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 tool with two parameters and no output schema, the description covers purpose, a behavioral trait (auto-backup), and param flexibility. It could mention that the snapshot must exist (from `bricks_list_snapshots`), but overall it is complete enough for basic use.

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 100% with both parameters described. The description adds 'Accepts snapshot ID or name,' which is already in the schema's description of snapshot_id. No significant additional meaning beyond the schema, so baseline 3 is appropriate.

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 a page from a named snapshot, using a specific verb ('restore') and resource ('page from snapshot'). It distinguishes from sibling tools like `bricks_restore_backup` and `bricks_restore_full_backup` by specifying snapshot-based restoration.

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 mentions creating an auto-backup before restoring, which implies a safety behavior, but does not provide explicit guidance on when to use this tool versus alternatives like `bricks_restore_backup` or prerequisites. Minimal context for usage decisions.

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