Skip to main content
Glama

List firewall aliases

proxmox_list_firewall_aliases
Read-only

Lists IP and network aliases at the datacenter or guest level, enabling named addresses in firewall rule sources and destinations.

Instructions

List IP/network aliases defined at datacenter (cluster) or guest level. Aliases are named addresses usable in rule source/dest.

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

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)
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.6/5.0
Behavior3/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 by structured data. The description adds the domain meaning of an alias, but says nothing about result size, pagination, or that omitted scope is inferred from vmid — behavior that only lives in the schema.

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?

Two sentences, front-loaded with the action and scope, and the second sentence earns its place by defining the resource term. No filler or redundant restatement of the title.

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 zero-required-parameter read-only list tool with no output schema, this is nearly sufficient: purpose, scope, and the meaning of an alias are all covered. The only gap is that nothing describes what a returned record contains or how many, which matters slightly since there is no output schema.

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 80%, so the schema already documents node, vmid, scope, and search in detail, including scope inference rules. The description reinforces the cluster-vs-guest distinction that scope encodes but adds no syntax, defaults, or filtering behavior beyond it; baseline 3 applies.

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 states a specific verb and resource ("List IP/network aliases") and delimits the two scopes (cluster vs guest). It does not name a sibling or explain how it differs from proxmox_list_firewall_ipsets/groups, but the resource noun is distinctive enough that an agent can separate it.

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: the second sentence explains that aliases are named addresses usable in rule source/dest, which hints at why one would list them (to resolve names for rules). There is no explicit when-to-use, no prerequisites, and no mention of alternatives such as ipsets or groups for other grouping needs.

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