Skip to main content
Glama

Get a firewall rule

proxmox_get_firewall_rule
Read-only

Retrieve a single Proxmox firewall rule by position at cluster, node, guest, or security-group level, including its digest for safe updates.

Instructions

Get one firewall rule by position at any level (cluster, node, guest or security group), with its digest for safe updates.

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": {
      "pos": "<pos>"
    },
    "name": "proxmox_get_firewall_rule"
  }
}

Input Schema

NameRequiredDescriptionDefault
posYesRule position (from proxmox_list_firewall_rules)
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.

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 establish readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds genuinely useful behavior beyond them: the result includes a digest intended for safe subsequent updates, which tells an agent how to chain this into a mutation. It stops short of describing error behavior for an out-of-range position.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One front-loaded sentence: verb, key, scope, then the returned digest. Nothing is wasted, though the parenthetical level list partially restates the scope enum.

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 read-only single-record fetch with a fully documented schema and no output schema, the definition covers what the agent needs: what is fetched, by what key, at what level, and one notable return field. Missing only edge-case behavior such as a nonexistent position.

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 coverage is 100%, so the baseline is 3, but the description adds a small amount of meaning by explaining that the position is scope-relative and can address any of the four firewall levels. It does not clarify required vs. optional scope resolution, which the schema already handles.

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?

The description gives a specific verb and resource ('Get one firewall rule') and pins the lookup key ('by position'), which distinguishes it from the sibling list tool without naming it. The parenthetical enumerates all four levels the rule can live at, so an agent knows the tool spans cluster/node/guest/group scopes.

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 only implied: 'by position' hints that a position must come from a listing call, but the description never says to call proxmox_list_firewall_rules first (that link appears only in the schema). It also gives no guidance on when to prefer this over list_firewall_rules or get_firewall_options.

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