Skip to main content
Glama

List firewall alias/IP set references

proxmox_list_firewall_refs
Read-only

List aliases and IP sets usable in Proxmox firewall rule source/destination fields at cluster or guest level, returning the exact reference strings to use.

Instructions

List the aliases and IP sets that can be used in rule source/dest at datacenter (cluster) or guest level, with the exact reference string to use (e.g. +dc/management, dc/myalias).

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

Input Schema

NameRequiredDescriptionDefault
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)
typeNoOnly aliases or only IP sets
vmidNoVM or container ID, for scope guest
scopeNoFirewall level: cluster = datacenter-wide; guest = a VM or container (give vmid). Inferred when omitted: guest if vmid is given, otherwise cluster.
fieldsNo
searchNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare a read-only, non-open-world operation, and the description adds the key non-obvious behavior: the response yields reference strings in a specific syntax (e.g. +dc/management, dc/myalias) rather than just names. It doesn't discuss scoping inheritance or how cluster-level entries behave under guest scope, and the idempotentHint=false annotation is left unaddressed for what is otherwise a pure read.

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?

A single front-loaded sentence with the resource first, the scope constraint second, and the concrete reference-string examples last. The examples are the one piece of information an agent genuinely cannot get from the schema, so every clause earns its place.

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 six-parameter, all-optional read tool with no output schema, the description does the important work of explaining what comes back (reference strings usable in source/dest). The remaining gap is that undocumented projection/filter parameters (fields, search) and the guest-vs-cluster inference rules are left to the schema alone.

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 67%, so the schema already carries most parameter meaning; the description only reinforces the scope dimension ('datacenter (cluster) or guest level') that the scope enum already documents. The 'fields' and 'search' parameters receive no clarification anywhere, and node/vmid resolution behavior (defaults, lookup from vmid) comes solely from the schema.

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 (list aliases and IP sets) plus the scope axis (datacenter vs guest) and what is returned (exact reference string with examples). It does not explicitly distinguish itself from the near-duplicate siblings proxmox_list_firewall_aliases and proxmox_list_firewall_ipsets, so an agent must infer that this one returns ready-to-use reference strings rather than alias/ipset records.

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 well by 'that can be used in rule source/dest' — i.e. call this before authoring a rule to get the correct reference token — but the description never names an alternative or a when-not condition. The choice between this tool and the single-type alias/ipset listers is left entirely to inference.

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