Skip to main content
Glama

unifi_gen_getfirewallzones

unifi_gen_getfirewallzones
Read-onlyIdempotent

Retrieves UniFi firewall zones with pagination and filtering to review or manage network policies.

Instructions

List Firewall Zones - generated from developer.ui.com/network/v11.0.97/getfirewallzones

Input Schema

NameRequiredDescriptionDefault
limitNo
filterNo
offsetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

C2.2/5.0
Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds nothing beyond that: no pagination defaults, no maximum result behavior (limit caps at 200), and no note that filter syntax is undocumented. Only the 'generated from developer.ui.com' provenance is added, which is not behaviorally useful.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

It is a single short, front-loaded line, so there is no padding in the sentence itself. However, the appended developer.ui.com URL is dead weight that consumes half the text without helping an agent decide or invoke.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, so the description should say what a firewall zone record contains and how pagination results are returned; it says neither. For a parameterized, open-world list tool this leaves the agent with more unknowns than knowns.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

All three parameters (limit, filter, offset) have 0% schema description coverage, so the description must carry their meaning and does not mention any of them. The filter string in particular is completely unexplained, leaving an agent with no way to construct a valid query.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

"List Firewall Zones" gives a clear verb plus resource, but it stops at restating the tool name. There is a near-identical sibling (unifi_net_list_firewall_zones) and a singular variant (unifi_gen_getfirewallzone), and the description offers no basis for choosing between them. The trailing source URL is provenance metadata, not purpose information.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no statement of when to use this tool rather than unifi_net_list_firewall_zones, when to page with limit/offset, or what filter accepts. An agent is left entirely to inference from the name.

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