Skip to main content
Glama

restore

DestructiveIdempotent

Reverts a named snapshot checkpoint by replacing the original child under its parent or a custom parentPath; recorded as one Studio undo step and the snapshot remains available for reuse.

Instructions

Put a snapshot checkpoint back: destroys the child with the original name under the original parent, then clones the checkpoint into its place. Recorded as one Studio undo step, and the snapshot is kept so you can restore it again. Use list_snapshots to find names. For script files tracked in git use git_restore or git_recover; for instances saved by the disk mirror use restore_from_mirror.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>"
    },
    "name": "restore"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesSnapshot name, as shown by list_snapshots.
placeNoTarget place (PlaceId or project name). Defaults to the bound/sole connected place.
parentPathNoRestore under this parent instead of the original one (dot path, e.g. "ServerStorage.Backup"). The first child there with the original name is replaced.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.1.1
    • addedInput schema / properties / name / description
      Added value: +"Snapshot name, as shown by list_snapshots."
    • changedInput schema / properties / parentPath / description
      Previous value: -"override the original parent"New value: +"Restore under this parent instead of the original one (dot path, e.g. \"ServerStorage.Backup\"). The first child there with the original name is replaced."
  2. First observedv0.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the annotations: it discloses exactly what is destroyed (the child with the original name under the original parent), that the operation is recorded as a single Studio undo step, and that the snapshot is preserved so the restore can be repeated. Those are the details an agent needs to judge risk, which destructiveHint=true alone does not convey.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences, all front-loaded: mechanism first, then undo/snapshot-persistence behavior, then the alternative-routing list. Every clause carries distinct information and no wording is redundant.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive one-shot operation with full schema coverage and no output schema, the description covers the side effects, the undo semantics, and the alternatives. The only omission is what the call returns, which is minor given there is no output schema and the effect is fully described.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and all three parameters are already documented in the schema, including the parentPath replacement semantics. The description's only parameter-adjacent sentence points at list_snapshots for the name, which the schema already says, so no meaning is added beyond the schema. Baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Names a specific verb (put back / restore) and resource (snapshot checkpoint) and spells out the mechanism: the existing child of the same name under the original parent is destroyed, then the checkpoint is cloned into its place. That mechanism is precisely what separates it from siblings like restore_from_mirror and git_restore, which are named explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit routing rules: use list_snapshots to discover names, git_restore or git_recover for git-tracked script files, and restore_from_mirror for instances saved by the disk mirror. Both when-to-use and when-not-to-use are stated with named alternatives, leaving nothing to inference.

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