Skip to main content
Glama

Get VM cloud-init data

proxmox_get_vm_cloudinit
Read-only

Retrieve a VM's cloud-init settings with current and pending values plus generated user-data, network-config, and meta-data as the guest sees them. Passwords redacted.

Instructions

Show a VM's cloud-init settings with current vs pending values (pending ones need proxmox_regenerate_vm_cloudinit or a restart to reach the guest), plus the generated user-data, network-config and meta-data as the guest will see them. Passwords are redacted.

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": {
      "vmid": "<vmid>"
    },
    "name": "proxmox_get_vm_cloudinit"
  }
}

Input Schema

NameRequiredDescriptionDefault
dumpNoWhich generated documents to include (default all three; [] for none)
nodeNoNode the guest is on. Looked up automatically from the VMID when omitted.
vmidYesVM or container ID (VMID), e.g. 100

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered; the description adds genuinely new context: the current-vs-pending distinction, that pending values are not yet visible to the guest, and that passwords are redacted. That redaction note is exactly the kind of behavioral disclosure annotations cannot convey.

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 dense sentence with the core purpose front-loaded and no filler. The parenthetical about pending values is longer than ideal but carries substantive meaning rather than repetition.

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 three-parameter read tool with full schema coverage and existing annotations, the description covers what is returned, the pending-state caveat, and the redaction behavior. It would be marginally stronger if it noted behavior when cloud-init is not configured, but nothing critical is missing.

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

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and all three parameters are self-documented, so the baseline is 3. The description's mention of user-data, network-config and meta-data loosely maps to the 'dump' enum but adds no format or default detail beyond the schema.

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 ('Show a VM's cloud-init settings') and enumerates exactly what is returned: current vs pending values plus generated user-data, network-config and meta-data. This clearly separates it from the broader proxmox_get_vm_config sibling.

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 rather than stated: an agent can infer this is for inspecting cloud-init specifically, and the description usefully notes that pending values require proxmox_regenerate_vm_cloudinit or a restart. However, it never explicitly contrasts this with proxmox_get_vm_config or says when one should be preferred.

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