Unofficial-Proxmox-MCP

pve_set_cloudinit

Configures Cloud-Init settings on a Proxmox QEMU VM, including user credentials, SSH keys, IP addressing, and DNS options.

Instructions

Configure Cloud-Init parameters on a QEMU virtual machine.

Args: vmid: Target VM ID. ciuser: Default cloud-init username (e.g. 'ubuntu' or 'debian'). cipassword: User password. sshkeys: URL-encoded or raw OpenSSH public key string. ipconfig0: IP addressing config (e.g. 'ip=dhcp' or 'ip=192.168.1.50/24,gw=192.168.1.1'). nameserver: DNS nameserver IP. searchdomain: DNS search domain. node: Optional node name.

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": "pve_set_cloudinit"
  }
}

Input Schema

Name	Required	Description	Default
`node`	No
`vmid`	Yes
`ciuser`	No
`sshkeys`	No
`ipconfig0`	No
`cipassword`	No
`nameserver`	No
`searchdomain`	No

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.2.0Nov 9, 2026

TDQS

B3.1/5.0

Behavior2/5

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

With no annotations supplied, the description carries the full behavioral burden and falls short. It does not say whether omitted parameters preserve existing values or clear them, whether the whole Cloud-Init config is replaced, or what permissions/state are required for a mutation of this kind.

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 purpose sentence is front-loaded and the Args block is compact, with each line earning its place through format examples. The docstring layout is slightly mechanical but contains no filler.

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?

The output schema exists, so return values need not be described, and parameter semantics are well covered. However, for an eight-parameter mutation with zero annotation coverage, the missing preconditions and overwrite semantics leave a meaningful gap.

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 largely does: every parameter is explained, with concrete formats for ciuser, sshkeys (URL-encoded vs raw), and ipconfig0 (dhcp vs static with gateway). Only node and vmid are described thinly, which keeps it below a 5.

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?

States a specific verb and resource: configuring Cloud-Init parameters on a QEMU VM, which is distinct from the create/clone/snapshot siblings. It does not explicitly contrast itself with alternatives like pve_create_vm, but the operation is unambiguous.

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

Usage Guidelines2/5

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

There is no guidance on when to use this tool versus related ones, and no prerequisites are given. It never states whether the VM must be stopped, whether a Cloud-Init drive must already exist, or whether this should be run before first boot.

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