Skip to main content
Glama

List firewall rules

proxmox_list_firewall_rules
Read-only

Lists Proxmox firewall rules for a cluster, node, VM/container, or security group in evaluation order, showing readable one-line entries to inspect access and ordering.

Instructions

List the firewall rules of the datacenter (cluster), a node, a VM/container (guest) or a security group, in evaluation order (pos 0 first). Each rule has a readable one-line form like 'IN SSH(ACCEPT) -i net0 -source +mgmt # admins'. Rules of type group pull in a security group's rules. For 'why can't I reach VM X' start with proxmox_get_guest_firewall_status.

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

Input Schema

NameRequiredDescriptionDefault
rawNoReturn the full unprocessed objects from the API (larger)
nodeNoNode name: the host for scope node (defaults to PROXMOX_DEFAULT_NODE or the only node), or the guest's node for scope guest (looked up from vmid when omitted)
vmidNoVM or container ID, for scope guest
groupNoSecurity group name, for scope group (see proxmox_list_firewall_groups)
scopeNoFirewall level: cluster = datacenter-wide; node = a host's own firewall; guest = a VM or container (give vmid); group = a security group's rules (give group). Inferred when omitted: guest if vmid is given, group if group is given, node if node is given, otherwise cluster.
fieldsNo
searchNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A4.1/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 the safety profile is covered; the description adds real value beyond that by describing the return shape (readable one-line rules), the positional ordering semantics, and that group rules are inlined. This is what the agent needs since there is no output schema. It does not discuss pagination or size limits for very large rulesets.

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?

Three sentences, front-loaded with the core action and scope, then output form, then the diagnostic redirect. Every sentence contributes; the parenthetical asides are compact rather than padded.

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?

With seven optional parameters, no output schema, and a 71% description coverage, the definition does enough: it explains scope selection, output representation, and where to start for a diagnostic question. Output filtering via fields/search and the effect of raw are left unstated, a minor gap for a read-only listing tool.

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 coverage is 71%, so most parameters are already documented in the schema, including the scope enum and its inference logic, node, vmid, and group. The description reinforces the scope choices but adds nothing for raw, fields, or search, which remain schema-only. Baseline 3 is appropriate when the schema carries most of the load.

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?

The description names a specific verb and resource and enumerates all four scopes (cluster, node, guest, group), plus states the ordering guarantee 'in evaluation order (pos 0 first)'. An agent can immediately distinguish this from proxmox_list_firewall_groups, proxmox_list_firewall_aliases, or proxmox_get_firewall_rule.

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

Usage Guidelines4/5

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

It gives explicit routing for one key scenario ('why can't I reach VM X' → start with proxmox_get_guest_firewall_status), which is genuine when-to-use guidance. It also clarifies that group-type rules expand into a security group's rules. It stops short of stating when to prefer get_firewall_rule or how alias/ipset lookups relate, so no full when/when-not coverage.

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