Skip to main content
Glama
AIops-tools

xcpng-aiops

by AIops-tools
OverviewSchemaRelated ServersScoreDiscussions
Python
Remote

vm_stop

Stop a VM using a clean guest shutdown, with an optional force power-off when guest tools are unavailable. Supports dry-run preview and protects the managing Xen Orchestra host.

Instructions

[WRITE][risk=medium] Stop a VM (clean shutdown; hard with force). Inverse: vm_start.

A clean shutdown needs the guest tools running; force maps to a hard
power-off. Captures the prior power state.

Refuses the VM declared as running Xen Orchestra (xo_self_vm_uuid on the
target) — stopping XO removes the API vm_start would travel over, so
recovery needs hypervisor console access. dry_run refuses it too: a preview
that returns green for a call that will be refused is a wrong preview. That
guard is exact and opt-in: an undeclared target is refused nothing, on
either path. The dry-run adds a weaker IP-based selfVmHint (null when there
is none) that is a coincidence to check, never a verdict and never a block —
XO's API exposes no self endpoint, so nothing here can be certain.

Args:
    vm_id: VM uuid (see vm_list).
    force: Hard power-off instead of a clean guest shutdown.
    dry_run: If True, preview without stopping (no undo recorded).
    target: Xen Orchestra target name from config; omit for the default.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
forceNo
vm_idYes
targetNo
dry_runNo

Tool Definition Quality

A4.9/5.0
Behavior5/5

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

Discloses key behaviors: captures prior power state, refuses to stop XO self VM, dry_run gives preview but refuses that specific call, and explains selfVmHint as a coincidence check. Without annotations, this carries the full burden and does so thoroughly.

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?

The description is somewhat verbose but well-structured with a summary line, detailed explanations, and a clear args section. Every sentence adds value, though it could be slightly condensed without losing clarity.

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?

Covers all aspects: mutation behavior, edge cases (self VM block, dry_run), parameter details, dependencies (guest tools), and recovery implications. No output schema exists, but the description provides sufficient context for correct invocation.

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?

Adds meaning beyond schema for all 4 parameters: vm_id references vm_list, force describes hard power-off, dry_run explains preview behavior and interaction with self-VM guard, target specifies Xen Orchestra target. Schema coverage is 0%, so description fully compensates.

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?

The description explicitly states it stops a VM, distinguishes between clean shutdown and hard power-off, and captures prior power state. It differentiates from sibling tools like vm_start, vm_reboot, and vm_migrate by focusing on stopping a VM.

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?

Provides clear when-to-use guidance: inverse of vm_start, force for hard power-off, clean shutdown needs guest tools. Also specifies when not to use: refuses the XO self VM and dry_run refusal. Includes context for target parameter and default handling.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/AIops-tools/XCPng-AIops'

If you have feedback or need assistance with the MCP directory API, please join our Discord server