Skip to main content
Glama

unifi_gen_getfirewallzone

unifi_gen_getfirewallzone
Read-onlyIdempotent

Retrieve a UniFi firewall zone by UUID to inspect its configuration details for network security management.

Instructions

Get Firewall Zone - generated from developer.ui.com/network/v11.0.97/getfirewallzone

Input Schema

NameRequiredDescriptionDefault
firewallZoneIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

D1.8/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is fully covered. The description adds nothing beyond a source documentation link — no information on behavior when the ID is unknown, whether it returns 404/empty, or required permissions.

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

Conciseness2/5

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

It is short, but this is under-specification rather than conciseness. The one non-redundant element is the developer.ui.com link, which is provenance metadata rather than actionable information for the calling agent.

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?

Annotations cover safety and there is no output schema, but the description still leaves the entire parameter undocumented and gives no hint about the returned zone object shape. For a lookup tool with a required UUID argument, this is a bare-minimum definition.

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

Parameters2/5

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

There is one required parameter (firewallZoneId) with 0% schema description coverage; the schema supplies only a UUID format/pattern with no prose meaning. The description does not mention the parameter at all, so it fails to compensate for the coverage gap — the agent cannot tell whether this is a zone UUID, name, or something else.

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

Purpose2/5

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

The description restates the tool name/title ('Get Firewall Zone') and adds only a provenance URL. It does not distinguish this tool from the near-identical sibling unifi_net_get_firewall_zone or clarify the singular-vs-list relationship with unifi_gen_getfirewallzones.

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

Usage Guidelines1/5

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

No guidance whatsoever on when to use this versus unifi_net_get_firewall_zone, unifi_gen_getfirewallzones, or unifi_net_list_firewall_zones. The agent must infer everything from the tool name alone.

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