Skip to main content
Glama
olvm-aiops

olvm-aiops

Official

vm_list

Read-only

List virtual machines with status, host, vCPU, memory, and high-availability flags, plus pagination and search filters for OLVM/oVirt engines.

Instructions

[READ] VMs with status, host, vCPUs, memory and high-availability flag.

Args: limit: Rows per page, 1-1000 (default 100); agents should use 20 or fewer so the model sees the entire page and its continuation metadata. search: Engine criteria, e.g. "status=up" or "cluster=Default"; omit page. target: Engine target name from config; omit to use the default. page: One-based page number (default 1). Follow nextPage until null.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "vm_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNo
limitNo
searchNo
targetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.7.2
    • addedInput schema / properties / page
      Added value: +{
      +  "default": 1,
      +  "title": "Page",
      +  "type": "integer"
      +}
  2. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so safety is covered; the description goes further by disclosing the paginated continuation model (`nextPage` until null), the 1-1000 limit ceiling with default 100, and the interaction rule that `search` should omit `page`. It does not cover permissions, ordering, or error behavior, which keeps it below 5.

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?

Purpose is front-loaded in a single bracketed line, followed by a tight per-parameter list with zero filler. The parenthetical rationale about the model seeing the whole page is slightly verbose but justifies the non-obvious limit recommendation.

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

Completeness4/5

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

For a list tool with no output schema, the description supplies the returned attributes and the pagination contract, which is what an agent needs to loop correctly. Minor gaps remain around result ordering and what continuation metadata looks like, but nothing essential to a correct call 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 full burden and does: it states ranges, defaults, and semantics for all four parameters, gives concrete search syntax examples ("status=up", "cluster=Default"), explains `target` resolution from config with a fallback to the default target, and clarifies `page` is one-based.

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?

Opening line gives a specific verb/resource pair ("[READ] VMs") plus the attributes returned (status, host, vCPUs, memory, HA flag), which cleanly separates it from the singular vm_get. It stops short of naming a sibling or stating it lists all VMs regardless of filters, so it is clear but not maximally differentiated.

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?

The args block gives operational guidance (use limit ≤20 for agents, omit `page` when using `search`, follow `nextPage` until null), which is useful for correct invocation. However, there is no when-to-use/when-not guidance relative to vm_get, vm_capacity_summary, or vm_stats, which are the plausible alternatives for VM data.

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