Skip to main content
Glama

xo_restore_backup

Restore a virtual machine from an XO backup, optionally targeting a specific storage repository or gateway, to recover workloads after data loss or failure.

Instructions

Restore a VM from an XO backup.

Write operation — recorded in the audit log.

Args: backup_id: Backup ID to restore. target_sr: Target storage repository UUID (optional). gateway_id: Target gateway (optional).

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": {
      "backup_id": "<backup_id>"
    },
    "name": "xo_restore_backup"
  }
}

Input Schema

NameRequiredDescriptionDefault
backup_idYes
target_srNo
gateway_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.72.5

TDQS

C2.7/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It does disclose that this is a write operation recorded in the audit log, which is useful, but it omits critical restore behavior: whether an existing VM is overwritten or a new one created, whether the call is asynchronous and returns a task, permission requirements, and whether the restore is reversible.

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?

Front-loaded one-line purpose followed by a write/audit note and a compact Args block. Every line earns its place; only the redundant param restatements cost a point.

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

Completeness2/5

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

For a high-stakes destructive-adjacent operation with no annotations and no output schema, the description leaves too much unstated: return value/task handle, overwrite semantics, failure modes, and required permissions all remain unknowns an agent would need to call this safely.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must compensate. It enumerates all three parameters but mostly restates their names; only "Target storage repository UUID" and the "(optional)" markers add any real meaning, and there is no detail on backup_id format or valid gateway/SR values.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: "Restore a VM from an XO backup." That is clearly distinct from siblings like xo_run_backup, xo_list_backups, and xo_snapshot_vm, though the description never explicitly contrasts itself with any of them.

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

Usage Guidelines2/5

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

No guidance on when to use this versus alternatives (e.g., migrate vs restore), no prerequisites such as whether the source backup must exist or the VM must be halted, and no mention of what backup_id is sourced from (presumably xo_list_backups). The only usage-relevant signal is that it is a write operation.

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