Skip to main content
Glama

xo_stop_vm

Cleanly shuts down a running XCP-ng VM using its VM ID and optional gateway ID, helping safely stop virtual machines via the MCP server.

Instructions

Cleanly shutdown a running XCP-ng VM.

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": {
      "vm_id": "<vm_id>"
    },
    "name": "xo_stop_vm"
  }
}

Input Schema

NameRequiredDescriptionDefault
vm_idYes
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 supplied, so the description carries the full burden. 'Cleanly shutdown' hints at a graceful/ACPI shutdown rather than a hard power-off, which is useful, but it says nothing about whether the call blocks or returns immediately, whether it can fail on an unresponsive guest, or what side effects occur.

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?

A single front-loaded sentence with zero filler or repetition. It is efficient, though the terseness borders on under-specification for a mutation tool.

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?

This is a state-changing operation with no annotations, no output schema, and undocumented parameters; a one-line description is not enough to convey its safety profile, blocking behavior, or parameter requirements.

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% across two parameters. 'vm_id' is weakly inferable from the word 'VM', but 'gateway_id' is completely unexplained in both the schema and the description, so the description does little to compensate for the coverage gap.

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?

The description gives a specific verb+resource ('shutdown a ... VM') plus the platform ('XCP-ng'), which implicitly separates it from sibling tools like proxmox_stop_vm and vsphere_stop_vm. It falls short of a 5 because it does not explicitly state the relationship to xo_start_vm or the restart-style siblings.

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?

The word 'running' implies a precondition (the VM must be powered on), but there is no explicit when-to-use/when-not guidance, no mention of alternatives, and no statement about what to do for already-stopped or hung VMs.

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