Skip to main content
Glama

restore_from_mirror

DestructiveIdempotent

Restore a missing or overwritten Roblox Studio instance from the on-disk mirror or its history by Studio path, with optional version selection and controlled replacement.

Instructions

Bring one instance back into the edit copy from the on-disk mirror or its .history, by Studio path (e.g. StarterGui.MineGui, StarterGui.FarmGui.Toasts, ReplicatedStorage.Mining.SomeModule). Works for anything inside a mirrored unit and for scripts. Without version it tries the live mirror file first, then history copies newest first, and uses the first one that still holds the path. One undo entry. Refuses to overwrite an existing same-named instance unless replace=true. Use mirror_history to pick a version.

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": "restore_from_mirror"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesStudio path of the instance to restore
placeNoTarget place (PlaceId or project name). Defaults to the bound/sole connected place.
replaceNodestroy an existing instance with the same name and class first
versionNohistory stamp from mirror_history, or 'current' for the live mirror file only
parentPathNoput it under this parent instead of its original spot

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.8/5.0
Behavior5/5

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

Goes well past the annotations: it discloses the fallback resolution order (live mirror first, then history newest-first, first copy that still contains the path), the single-undo-entry footprint, and the non-destructive guard against overwriting same-named instances. The destructiveHint=true annotation is contextualized by that guard rather than merely restated.

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?

Purpose and target are front-loaded in the first clause, followed by defaults, undo footprint, and the refusal constraint in roughly priority order. Every sentence carries operational information; the path examples are the only indirection and they establish input format.

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 5-parameter mutation tool with no output schema and clear annotations, the description covers resolution order, safety, and undo cost. The one gap is what comes back (e.g. which source/version was used to satisfy the restore), which an agent may want without an output schema to consult.

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

Parameters4/5

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

Schema coverage is 100%, so baseline is 3, but the description adds real semantics the schema lacks: the default resolution chain when `version` is omitted and the overwrite guard governing `replace`. `parentPath` is not elaborated beyond the schema text, which keeps it from a 5.

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?

States a specific verb and resource ('Bring one instance back into the edit copy from the on-disk mirror or its .history') with scope qualifiers ('anything inside a mirrored unit and for scripts'). The Studio-path examples make the unit of operation unambiguous and distinguish it from the sibling mirror_history.

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?

Explicitly routes the agent: without `version` the search order is live mirror file then history newest-first, and 'Use mirror_history to pick a version' names the alternative tool and the condition that selects it. It also states the refusal case (won't overwrite unless replace=true), so both when-to-use and when-not-to-use are covered.

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