Skip to main content
Glama
Sign In
Archiware MCP

Archiware MCP

by mnott
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

restore_volume

Restore an entire P5 backup volume—all clients and paths—to an alternate directory. Preview the plan and confirm with its planId to start the job.

Instructions

EXPLICIT whole-volume restore: EVERYTHING on a P5 backup volume (all clients, all paths) goes to an alternate directory (RestoreSelection addfromvolume). Not for single files (use restore). Preview shows the volume, its used size, free space and a planId; confirm:true must pass that planId. Returns the job id.

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": {
      "volume": "<volume>"
    },
    "name": "restore_volume"
  }
}

Input Schema

NameRequiredDescriptionDefault
toNoAbsolute directory in the P5 container; default <restoreRoot>/<stamp>
planIdNoplanId printed by the preview; required with confirm:true. A changed destination or new conflicts make the call refuse and show the new plan
volumeYesBackup volume id (see volumes / restore_lookup)
confirmNoMust be true to actually run (with planId)
forceSyncNoAllow to:'original' inside a configured syncRoot
onConflictNoWhat to do when a destination file exists: refuse (default), rename (<name>.restored-YYYYMMDD; not for P5 volume restores) or overwrite

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.1

TDQS

A4.3/5.0
Behavior4/5

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

With no annotations, the description carries the burden and does well: it discloses the preview-then-confirm gate, that a changed destination or new conflicts cause the call to refuse and reissue a plan, and that the return value is a job id. It stops short of stating permission requirements or explicitly labeling the operation destructive to the destination.

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

Conciseness4/5

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

Three tight sentences, front-loaded with the defining scope before the exclusion and the mechanics. Capitalized emphasis earns its place for a high-blast-radius tool, though the phrasing is slightly dense with parenthetical detail.

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 6-parameter mutation with no output schema, the description covers scope, the preview/confirm protocol, refusal behavior and the job-id return. Conflict and sync-root edge cases live in the schema, which is acceptable given full coverage.

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 coverage is 100%, so volume, to, planId, confirm, forceSync and onConflict are already documented. The description reinforces the planId/confirm coupling and the preview output, but largely restates what the schema already says, so the 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?

States a specific verb and scope: 'EXPLICIT whole-volume restore' moving 'EVERYTHING on a P5 backup volume (all clients, all paths)' to an alternate directory. It also explicitly separates itself from the sibling 'restore' for single files, so an agent can route correctly without opening the 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-not ('Not for single files') paired with the alternative to use instead ('use restore'). The two-phase preview/confirm workflow is also framed as a required procedure, leaving little to inference.

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

Deploy Server

Other Tools