Skip to main content
Glama
Sign In
owine

UniFi Network MCP Server

by owine
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

List firewall zones

unifi_list_firewall_zones
Read-only

List firewall zones at a UniFi site to inventory network groupings used for zone-based firewalling, including system-defined and user-defined zones.

Instructions

List firewall zones (groupings of networks for zone-based firewalling) at a site. Returns: id, name, networkIds[], metadata.origin (indicates system-defined vs user-defined). Use for: zone inventory; pair with unifi_list_firewall_policies to see rules between zones.

Input Schema

NameRequiredDescriptionDefault
limitNoNumber of records to return (API default: 25)
filterNoFilter expression, e.g. name.eq('Internal'). NOTE: totalCount ignores the filter on this endpoint (observed 11.0.83) — page by count
offsetNoNumber of records to skip
siteIdYesSite ID

Output Schema

NameRequiredDescriptionDefault
dataYes
countNo
limitNo
offsetNo
totalCountNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv2.15.0
    • changedInput schema / properties / filter / description
      Previous value: -"Filter expression"New value: +"Filter expression, e.g. name.eq('Internal'). NOTE: totalCount ignores the filter on this endpoint (observed 11.0.83) — page by count"
    • changedInput schema / properties / limit / description
      Previous value: -"Number of records to return (default: 25, max: 200)"New value: +"Number of records to return (API default: 25)"
    • changedInput schema / properties / offset / description
      Previous value: -"Number of records to skip (default: 0)"New value: +"Number of records to skip"
    • addedInput schema / properties / siteId / pattern
      Added value: +"^[A-Za-z0-9_-]{1,64}$"
    • changedOutput schema / additionalProperties
      Previous value: -falseNew value: +{}
    • addedOutput schema / properties / data / items / properties / metadata / properties / configurable
      Added value: +{
+  "type": "boolean"
+}
  2. Changed1 schema field changedv2.13.0
    • changedInput schema / properties / limit / minimum
      Previous value: -1New value: +0
  3. First observedv2.8.0

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, covering the safety profile. The description adds which fields are returned and the meaning of metadata.origin (system vs user-defined), but says nothing about permissions, pagination limits, or the filter/count quirk noted 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?

Compact and front-loaded, using a clear 'Returns:' / 'Use for:' structure. Every clause earns its place with no filler.

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?

Given an output schema exists, the return-value detail is optional but reinforces completeness, and the pairing hint aids correct usage. It remains slightly thin on operational constraints, but adequate for a read-only list tool.

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 the schema already documents siteId, limit, offset, and the filter/count caveat. The description adds no parameter-level meaning beyond that, making the baseline 3 appropriate.

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?

States a specific verb (List) and resource (firewall zones) and defines the concept inline as 'groupings of networks for zone-based firewalling at a site.' This cleanly separates it from the singular sibling unifi_get_firewall_zone and from unifi_list_firewall_policies.

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?

Provides explicit usage context: 'Use for: zone inventory' and names the complementary sibling to pair with (unifi_list_firewall_policies). No when-not guidance or prerequisites are given, but the routing context is clear.

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