Skip to main content
Glama

Get firewall policy order

unifi_get_firewall_policy_ordering
Read-only

Fetch the evaluation order of user-defined firewall policies between two zones, including before/after system-defined policy ID lists, to inspect policy precedence.

Instructions

Get the evaluation order of user-defined policies between a source and destination zone (beforeSystemDefined / afterSystemDefined policy ID lists). Uses the official integration API, so it requires API-key authentication (UNIFI_API_KEY) and Network 9.0+.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "source_zone_id": "<source_zone_id>",
      "destination_zone_id": "<destination_zone_id>"
    },
    "name": "unifi_get_firewall_policy_ordering"
  }
}

Input Schema

NameRequiredDescriptionDefault
siteNoSite name/ID as used in the API (e.g. 'default'). Defaults to the configured site. See unifi_list_sites.
source_zone_idYesSource zone ID (v2 _id from unifi_list_firewall_zones, or integration API id)
destination_zone_idYesDestination zone ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.8.1

TDQS

A3.6/5.0
Behavior4/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; the description adds real context beyond that by disclosing the dependency on the official integration API, API-key authentication via UNIFI_API_KEY, and a Network 9.0+ version floor. It does not mention failure modes or whether empty lists are returned when no user policies exist, which keeps it short of a 5.

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

Conciseness4/5

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

One sentence states the purpose and the return shape, a second carries the prerequisites. Front-loaded and free of filler; the parenthetical ID-list note is dense but informative rather than redundant.

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

Completeness5/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 supplies the return shape itself (the two ordered policy ID lists), and it also surfaces the authentication and version prerequisites an agent needs before calling. Nothing material for correct invocation is missing.

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 100%, so site, source_zone_id, and destination_zone_id are fully documented in the schema itself. The description confirms the zone pairing concept but adds no syntax, format, or cross-parameter constraints beyond the schema.

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?

Names a specific verb and resource ('get the evaluation order of user-defined policies') and scopes it to a source/destination zone pair, then describes the returned structure (beforeSystemDefined / afterSystemDefined policy ID lists). This clearly separates it from a plain policy listing such as unifi_list_firewall_policies, though no sibling is named explicitly.

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?

The description never states when to reach for this tool versus unifi_list_firewall_policies, unifi_list_firewall_rules, or unifi_check_firewall_path. The only conditional content is a prerequisite (integration API, Network 9.0+), not usage guidance.

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