Skip to main content
Glama

List firewall IP sets

proxmox_list_firewall_ipsets
Read-only

List Proxmox firewall IP sets and their entries at cluster or guest level so you can reference them in rules as +name, including management, blacklist and ipfilter sets.

Instructions

List IP sets at datacenter (cluster) or guest level with their entries (CIDRs, nomatch exclusions, comments). Reference them in rules as +name (or +dc/name, +guest/name). Special sets: 'management' (hosts allowed to reach the web UI/SSH when the firewall is on), 'blacklist', and per-NIC 'ipfilter-netX' on guests.

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

Input Schema

NameRequiredDescriptionDefault
nameNoOnly this IP set
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
scopeNoFirewall level: cluster = datacenter-wide; guest = a VM or container (give vmid). Inferred when omitted: guest if vmid is given, otherwise cluster.
fieldsNo
searchNoCase-insensitive substring filter on names, IDs, tags and similar fields

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 readOnlyHint=true and openWorldHint=false, so safety is covered; the description adds real domain behavior by enumerating entry contents and naming special sets ('management', 'blacklist', 'ipfilter-netX') whose semantics differ from ordinary sets. It does not discuss return shape or ordering, and the idempotentHint=false annotation is left unexplained.

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 dense sentences, front-loaded with the verb and scope, and the reference syntax follows immediately. The special-set sentence is long but earns its place by disambiguating set names; no filler or repetition.

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 6-parameter, read-only listing tool with no output schema, the description covers scope, entry contents, and name semantics well enough to call it correctly. The gaps are minor: the undocumented 'fields' parameter and the absence of any statement about result volume or ordering.

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?

With 83% schema coverage the schema already carries most parameter meaning, but the description adds the '+dc/name' vs '+guest/name' convention that clarifies the cluster-vs-guest scope distinction and tells the agent what values a set 'name' can take. The 'fields' parameter remains undocumented in both schema and description.

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 IP sets') plus the two scopes (datacenter/cluster vs guest) and what each entry carries (CIDRs, nomatch exclusions, comments). This is clearly distinguishable from rule/alias/group listing tools, though no sibling is named explicitly.

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?

The description explains how the returned sets are consumed ('Reference them in rules as +name (or +dc/name, +guest/name)'), which implies usage context, but gives no when-to-use/when-not-to-use guidance relative to the other firewall listing tools.

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