Skip to main content
Glama

List firewall zones

unifi_list_firewall_zones
Read-only

List UniFi zone-based firewall zones to retrieve zone_key, system-defined status, network IDs, and integration_id needed for firewall policies and path checks.

Instructions

List zone-based firewall zones (Network 9.0+) with zone_key, system-defined flag, network IDs and integration_id. Firewall policies and unifi_check_firewall_path refer to zones by these IDs.

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

Input Schema

NameRequiredDescriptionDefault
rawNoReturn the full controller objects (large)
siteNoSite name/ID as used in the API (e.g. 'default'). Defaults to the configured site. See unifi_list_sites.
fieldsNoOnly return these fields per item (dot paths, e.g. uplink.name)
searchNoCase-insensitive substring match on names, MACs, IPs and similar

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.9.1
    • addedInput schema / properties / fields / description
      Added value: +"Only return these fields per item (dot paths, e.g. uplink.name)"
    • addedInput schema / properties / search / description
      Added value: +"Case-insensitive substring match on names, MACs, IPs and similar"
  2. First observedv0.8.1

TDQS

A4/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 safety is covered and the description's job is to add context. It does add the Network 9.0+ applicability constraint, which is genuinely useful and not in the annotations. It does not address behavior such as ordering, empty results, or pagination, and notably does not explain the idempotentHint=false annotation on what appears to be a plain list operation.

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 tightly written sentences, with the resource scope and returned identifiers front-loaded and the cross-tool context second. No filler and nothing repeated from the schema or annotations.

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 no output schema, the description usefully enumerates the key returned fields and adds the version precondition, which is what an agent needs before calling. Minor gaps remain around ordering and result volume, but for a simple read-only list tool with full schema coverage and clear annotations, it is close to complete.

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 description coverage is 100%, so all four parameters (raw, site, fields, search) are already documented at the schema level. The description adds no meaning about how these parameters affect zone listing, so it neither compensates nor detracts. The baseline of 3 applies.

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 gives a specific verb and resource ('List zone-based firewall zones') and pins down the exact returned identifiers (zone_key, system-defined flag, network IDs, integration_id). It also distinguishes this from the firewall policy/path siblings by stating that those tools refer to zones by these IDs, so an agent can tell the tools apart without opening a schema.

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?

The second sentence establishes the usage context: resolve zone IDs here before working with firewall policies or unifi_check_firewall_path. That is clear routing guidance, but it is implied rather than stated as an explicit when-to-use/when-not-to-use rule, and no alternatives for other listing needs are named.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.