Skip to main content
Glama

snapshot

Destructive

Checkpoint a Roblox instance and its entire subtree before risky edits so restore can revert it exactly, even after Studio's undo stack moves on.

Instructions

Checkpoint an instance and everything under it before a risky edit, so restore can put it back exactly. Stores a live clone in ServerStorage._TufanSnapshots, which survives after Studio's undo stack has moved on and is saved with the place. Saving under an existing snapshot name replaces that snapshot. Archivable=false descendants are included. Use this for instances in the place; for script files on disk use git_commit, and for GUIs or models lost to a delete 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": {
      "path": "<path>"
    },
    "name": "snapshot"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoSnapshot name. Defaults to <InstanceName>_<unix time>. An existing snapshot with this name is replaced.
pathYesInstance to checkpoint (its whole subtree is copied). Dot path from the DataModel root, e.g. "Workspace.Map.Door" or "StarterGui.HUD.Frame". A leading "game." is optional; a duplicate sibling name takes the suffix Tufan prints, e.g. "Part (2)".
placeNoTarget place (PlaceId or project name). Defaults to the bound/sole connected place.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.1.1
    • changedInput schema / properties / name / description
      Previous value: -"snapshot name (default: <instance>_<timestamp>)"New value: +"Snapshot name. Defaults to <InstanceName>_<unix time>. An existing snapshot with this name is replaced."
    • addedInput schema / properties / path / description
      Added value: +"Instance to checkpoint (its whole subtree is copied). Dot path from the DataModel root, e.g. \"Workspace.Map.Door\" or \"StarterGui.HUD.Frame\". A leading \"game.\" is optional; a duplicate sibling name takes the suffix Tufan prints, e.g. \"Part (2)\"."
  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?

Annotations only declare destructiveHint=true and idempotentHint=false; the description supplies the real behavioral context: the clone lives in ServerStorage._TufanSnapshots, survives after Studio's undo stack has moved on, is saved with the place, silently replaces an existing snapshot of the same name, and includes Archivable=false descendants. The replacement semantics explain the destructiveHint flag rather than contradicting it.

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?

The purpose and the safe-edit framing are front-loaded, storage location and replace semantics follow, and the sibling routing is last. Every sentence carries distinct information with no repetition of the tool name or restatement of schema fields.

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 mutation tool with no output schema, the description covers durability, storage location, overwrite behavior, and the restore pairing, which is what an agent needs to act safely. It stops short of saying what the call returns (e.g., the snapshot name to pass to restore), a minor residual gap since the default naming is only implied via the schema.

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%, including path format, name defaulting, and place resolution, so the schema already carries parameter meaning. The description's only parameter-adjacent statement (reuse of an existing snapshot name replaces it) duplicates the schema text. Baseline 3 applies as the schema does the heavy lifting.

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 (checkpoint) and resource (an instance and its whole subtree), plus the purpose (safety before a risky edit) and the complementary tool (restore). It also explicitly distinguishes itself from git_commit and restore_from_mirror, so an agent can route correctly without opening any schema.

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 an explicit when-to-use ('before a risky edit'), an explicit alternative for out-of-scope cases ('for script files on disk use git_commit', 'for GUIs or models lost to a delete use restore_from_mirror'), and states the boundary ('instances in the place'). This is close to a routing decision tree.

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