Skip to main content
Glama

Restore volume

runzero_restore_volume
Destructive

Replace the data on the persistent volume with a backup. The service stops, the current data is backed up first, the backup is unpacked, and the service starts again. Takes minutes; follow it with runzero_volume_status (restore.phase ends at done, with error if it failed and the data stayed unchanged).

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": {
      "app": "<app>",
      "backupId": "<backupId>"
    },
    "name": "runzero_restore_volume"
  }
}

Input Schema

NameRequiredDescriptionDefault
appYesName of the app
serviceNoService name (default: the only service)
backupIdYesId of the backup, from runzero_volume_status

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already declare destructiveHint=true and idempotentHint=false, and the description builds on that with the actual mechanics: service stop, automatic pre-backup of current data, unpack, restart. It adds the crucial safety detail that on failure the data stays unchanged, plus a duration expectation ('takes minutes') and the terminal state (`restore.phase` = `done` or `error`). Nothing here contradicts the annotations.

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 short sentences, front-loaded with the primary effect and the destructive scope, followed by the execution sequence and then the follow-up guidance. No filler or restated title wording.

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?

For a destructive, minutes-long, no-output-schema operation, the description covers impact, sequence, duration, error semantics, and how to observe completion via runzero_volume_status. An agent has everything needed to call it and verify the result.

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%, so all three parameters (app, service, backupId) are already documented in the schema, including the note that backupId comes from runzero_volume_status. The description adds no further parameter-level meaning, so the baseline of 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?

States a specific verb and resource: 'Replace the data on the persistent volume with a backup.' This is clearly distinguishable from the sibling runzero_backup_volume, which does the inverse operation, and from runzero_restore_release.

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

Usage Guidelines4/5

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

Gives clear operational context — the service goes down, so the call should be treated as a maintenance action — and explicitly instructs the agent to follow it with runzero_volume_status. It does not, however, contrast against the other restore-flavored sibling (runzero_restore_release) or state prerequisites such as a valid backup from runzero_volume_status being required first.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.