Unofficial-Proxmox-MCP

pve_get_firewall

Inspect active firewall rules and security options on a Proxmox VE VM or LXC container by VM ID, with an optional node, to verify and troubleshoot network access.

Instructions

Inspect the firewall rules and security options active on a VM or container.

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_get_firewall"
  }
}

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

C2.9/5.0

Behavior2/5

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

With no annotations, the description carries the full behavioral burden and mostly does not meet it: it does not state that the operation is read-only, whether it returns VM-level rules only or also cluster/datacenter-level firewall state, what permissions are needed, or whether the guest must be running. Only the word 'active' hints that enabled/applied rules are returned rather than all configured rules.

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 sentence of purpose followed by a compact Args block – front-loaded, no filler, and the required vmid is listed first. The boilerplate 'Args:' formatting is functional rather than elegant but costs little.

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 values need not be explained, and both parameters are named. What is missing is behavioral context that matters for a firewall read on a hypervisor: scope of rules returned and any prerequisite such as node disambiguation or permissions, leaving a moderately complete but not self-sufficient definition.

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 must supply meaning, and it does define both parameters: vmid as the target VM or LXC container ID and node as optional. However, 'Optional node name' gives no guidance on when it must be supplied (e.g., ambiguity across nodes), so half the parameter semantics remain thin.

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 ('Inspect') plus the resource ('firewall rules and security options') and scope ('active on a VM or container'), which reads clearly as a read operation and contrasts implicitly with pve_set_firewall_rule. It stops short of naming the sibling it is not, so an agent must infer the read/write split from the verb alone.

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 explicit when-to-use guidance, no exclusions, and no mention of the obvious alternative pve_set_firewall_rule for changing rules. The word 'Inspect' implies a read-only inspection context, but the agent is left to infer that this tool must not be used to modify rules.

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