Skip to main content
Glama
AIops-tools

Veeam AIops

by AIops-tools
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

start_vm_restore

Destructive

Restore a VM from a Veeam restore point, overwriting or creating it. Use dry_run to preview the target, then confirm before approving the irreversible operation.

Instructions

[WRITE] Start a VM restore from a restore point. IRREVERSIBLE — no undo token.

Overwrites or creates a VM; confirm with the user before calling. Runs as an async session — poll with session_list / session_get. Pass dry_run=True to preview: the preview resolves the opaque restore-point id to the VM name and creation time it would restore, so there is something real to confirm.

Refuses when that VM name matches the configured VBR host — with no target mapping this is a restore-to-original, so it would overwrite the Veeam server serving this API. The name check is a safety net, not a proof (a VM display name is not a hostname); read the preview before approving.

Refuses separately when the restore point cannot be READ at all, because then it cannot name the machine it would overwrite — a preview reporting vmName: null is not something to approve. Set acknowledge_unresolved=True only when the user has confirmed the target in the Veeam console.

Args: restore_point_id: Restore point id (see restore_list_points). dry_run: If True, preview without restoring. acknowledge_unresolved: Proceed even though the restore point could not be read and the target machine is therefore unknown. target: Veeam target name from config.

Input Schema

NameRequiredDescriptionDefault
targetNo
dry_runNo
restore_point_idYes
acknowledge_unresolvedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.15.2
    • addedInput schema / properties / acknowledge_unresolved
      Added value: +{
+  "default": false,
+  "title": "Acknowledge Unresolved",
+  "type": "boolean"
+}
  2. Changed1 schema field changedv0.8.0
    • addedInput schema / properties / dry_run
      Added value: +{
+  "default": false,
+  "title": "Dry Run",
+  "type": "boolean"
+}
  3. First observedv0.2.0

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already declare destructive/non-idempotent/non-readonly, and the description adds far more: irreversibility with no undo token, overwrite-or-create semantics, async session polling, and two distinct refusal paths (VBR host name match, unreadable restore point) with an explicit caveat that the name check is a safety net, not a proof.

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 with the write/irreversible warning and structured prose plus an Args block, so it is easy to scan. Slightly repetitive on the approval theme ("confirm with the user", "read the preview before approving", "not something to approve"), which costs a point.

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?

No output schema exists, but the description covers return-path behavior (async session, poll with session_list/session_get) and preview output content, plus all refusal conditions an agent must handle. Nothing needed to call it correctly is missing.

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

Parameters5/5

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

Schema description coverage is 0%, so the description carries the burden and does: restore_point_id points to restore_list_points, dry_run's preview resolves the opaque id to vmName/creation time, acknowledge_unresolved's risky meaning is spelled out, and target's from-config sourcing plus the no-target = restore-to-original behavior is explained.

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?

Opens with a specific verb+resource+source ("Start a VM restore from a restore point") and marks the operation class with [WRITE], which cleanly distinguishes it from read-side siblings like restore_list_points and the job_*/session_* tools.

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 states when to use dry_run=True for preview, when to set acknowledge_unresolved=True (only after user confirmation in the Veeam console), that the user must confirm before calling, and how to follow up via session_list/session_get. Alternatives and exclusions are all present.

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