Skip to main content
Glama

env_restore

Restore an environment to a named snapshot, discarding all modifications made after that snapshot.

Instructions

Rewind an environment to a named snapshot taken with env_snapshot. Everything done since that snapshot is lost. Use env_revert instead to go back to the environment's original clean state.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesname of the environment
snapYesname of the snapshot

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
logNo
nameYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.2

TDQS

A4.7/5.0
Behavior5/5

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

It states the side effect directly: 'Everything done since that snapshot is lost.'

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 description is concise, with three sentences: action, consequence, and alternative. No unnecessary words.

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

Completeness5/5

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

Within the context of many sibling tools, it clearly distinguishes env_restore from env_revert and references env_snapshot for snapshot creation. The warning about data loss is also provided.

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?

The description does not elaborate on parameters, but the schema provides descriptions for both 'name' and 'snap' as the environment and snapshot names, respectively. Since schema coverage is 100%, baseline 3 is maintained.

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?

The description clearly states the purpose: rewinding an environment to a named snapshot. It distinguishes it from env_revert for original state.

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?

It explicitly says 'Use env_revert instead' for a different scenario, providing a clear alternative. It also warns about losing changes, guiding appropriate usage.

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