Unofficial-Proxmox-MCP

pve_export_terraform

Exports a live Proxmox VM or container specification into a ready-to-run Terraform or OpenTofu .tf block, so you can convert existing infrastructure into reusable code.

Instructions

Export the complete live specification of a VM or container into a ready-to-run Terraform / OpenTofu (.tf) block.

Args: vmid: Target VM or LXC Container ID. 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_export_terraform"
  }
}

Input Schema

Name	Required	Description	Default
`node`	No
`vmid`	Yes

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.2.0Nov 9, 2026

TDQS

A3.6/5.0

Behavior3/5

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

No annotations are supplied, so the description carries the full burden, and 'live specification' at least implies a read-only export that does not mutate the guest. It leaves undisclosed whether the result is returned inline vs written to disk, and does not warn that the emitted block may contain sensitive values (cloud-init, keys) that should not be committed.

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?

One front-loaded sentence stating what is produced, followed by a compact Args block; nothing is padded. The Args section partly restates the schema, but that is justified given zero schema description coverage.

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?

An output schema exists, so return-value explanation is not required, and the tool is small (2 params, 1 required). Still, with no annotations the definition should say whether the call is side-effect free and how node omission is resolved; those gaps keep it at adequate rather than complete.

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 0%, so the description is the only source of parameter meaning; it identifies vmid as a VM or LXC container ID and node as an optional node name. However, it does not explain the consequence of omitting node (the schema default is an empty string, so presumably auto-resolution) or any format/range constraints.

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 ('Export the complete live specification of a VM or container') plus the concrete output artifact ('ready-to-run Terraform / OpenTofu (.tf) block'). That output format makes it unmistakable against read-oriented siblings such as pve_get_system, since none of them produce IaC.

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 by the artifact it produces (generating IaC from a live guest), but there is no explicit when-to-use guidance, no note on when to prefer pve_get_system instead, and no stated prerequisites such as which provider/version the emitted block targets.

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