Skip to main content
Glama
Sign In
AIops-tools

xcpng-aiops

by AIops-tools
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

vm_list

Read-only

List VMs with power state, host, tools status, and sizing. Filter by power state or pool, and raise the limit when results are truncated.

Instructions

[READ] List VMs with power state, host, tools status, sizing.

Returns {"vms": [...], "returned": N, "limit": L, "truncated": bool}.
When truncated is true there are more VMs than were returned — re-run with
a higher limit rather than treating this as the whole fleet.

Args:
    power_state: Optional filter (Running / Halted / Paused / Suspended).
    pool: Optional pool uuid to filter by.
    limit: Max VMs to return after filtering (default 200).
    target: Xen Orchestra target name from config; omit for the default.

Input Schema

NameRequiredDescriptionDefault
poolNo
limitNo
targetNo
power_stateNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations only declare readOnlyHint=true, so the description carries the rest and does so well: it documents the exact return envelope (vms/returned/limit/truncated), the truncation pitfall, and the default limit of 200. It does not mention auth requirements or ordering/pagination behavior beyond limit, leaving a modest gap.

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?

Front-loads the purpose, then the return shape and truncation caveat, then a compact args block. Every sentence adds information; nothing is redundant filler despite the multi-section layout.

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?

With no output schema, the description steps in to describe the response envelope and the truncation flag, and it covers all four parameters. An agent has everything needed to call this correctly and interpret the result without opening a schema.

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% and no enums are declared, so the description does all the work: it supplies the accepted power_state values (Running/Halted/Paused/Suspended), explains pool as a uuid filter, states the limit default, and clarifies that target comes from config and may be omitted. This meaningfully exceeds what the bare schema provides.

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 ('[READ] List VMs') and enumerates the returned fields (power state, host, tools status, sizing), which distinguishes it from vm_get, vm_stats and vm_health_rca at a glance. The [READ] marker reinforces the operation type.

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

Usage Guidelines4/5

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

Gives clear operational guidance — re-run with a higher limit when 'truncated' is true rather than treating the result as the whole fleet — plus filter semantics for power_state and pool. It never names a sibling (e.g. vm_get for a single VM) or states when not to use this tool, so it stops short of full when/when-not coverage.

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