Skip to main content
Glama

xo_rolling_pool_update

Starts a rolling XCP-ng pool update by patching and rebooting hosts one at a time, live-migrating VMs first to keep workloads available.

Instructions

Start a rolling pool update — patches all XCP-ng hosts one by one.

VMs are automatically live-migrated to other hosts before each host is patched and rebooted. Zero downtime for running workloads.

Write operation — recorded in the audit log.

Args: pool_id: XCP-ng pool UUID (from xo_list_pools). 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": {
      "pool_id": "<pool_id>"
    },
    "name": "xo_rolling_pool_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
pool_idYes
gateway_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.72.5

TDQS

A4.1/5.0
Behavior4/5

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

With no annotations supplied, the description carries the full burden and does so well: it discloses that hosts are patched and rebooted one at a time, that VMs are live-migrated beforehand, that workloads see zero downtime, and that the action is a write recorded in the audit log. What it omits is that this is a long-running asynchronous operation, whether any progress or task handle is returned, and whether it can be cancelled mid-run.

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?

The description leads with the action and scope, then covers side effects and safety in two short sentences, then lists args. The 'zero downtime' line is slightly redundant with the live-migration statement but reinforces the key operational guarantee; no sentence is wasted.

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

Completeness3/5

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

For a pool-wide write operation with no annotations and no output schema, the description explains the mechanical behavior thoroughly but says nothing about how to observe completion or failure, which is a significant gap for a long-running reboot cycle. An agent knows what it will trigger but not what it gets back or how to follow up.

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

Parameters4/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, and it does: pool_id is identified as an XCP-ng pool UUID, explicitly pointing to xo_list_pools as the source of a valid value, and gateway_id is marked optional. Only the gateway_id semantics ('Target gateway') remain thin.

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 ('Start a rolling pool update') and immediately defines the scope: patches all XCP-ng hosts one by one. This is clearly distinguishable from the xo_list_* and xo_migrate_vm siblings because it describes a pool-wide operation rather than a listing or single-VM action.

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

Usage Guidelines3/5

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

Usage is implied by the description of what the tool does, but there is no explicit when-to-use or when-not guidance, no mention of prerequisites (such as pool health checks), and no reference to alternatives for single-host patching. An agent must infer the trigger conditions itself.

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