Skip to main content
Glama

List firewall groups

unifi_list_firewall_groups
Read-only

List firewall groups referenced by UniFi firewall rules and policies, including address, IPv6 address, and port groups, so you can identify which groups are in use.

Instructions

List firewall groups (address groups, IPv6 address groups and port groups) referenced by firewall rules and policies.

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_groups"
  }
}

Input Schema

NameRequiredDescriptionDefault
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

A3.6/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 the safety profile is covered. The description adds domain context that these groups are the ones referenced by rules and policies, but says nothing about whether the full set is returned, whether results are paginated, or what permissions are needed; the idempotentHint=false on a pure list operation is also left unexplained.

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?

A single front-loaded sentence that identifies the resource, its subtypes, and its relationship to other firewall objects with no wasted wording.

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?

For a simple read-only list tool with a fully documented three-parameter schema and clear annotations, this is close to sufficient. The only remaining gap is whether the listing is complete or scoped in some way, which matters when the agent later resolves group references.

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 site, fields, and search are already documented with examples and defaults. The description adds no additional meaning about these parameters (e.g., whether search matches group names specifically or whether fields applies to nested items), so the baseline of 3 applies.

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?

The description names a specific verb and resource ('List firewall groups') and enumerates the subtypes covered (address groups, IPv6 address groups, port groups), which separates it from siblings like unifi_list_ap_groups or unifi_list_firewall_rules. It stops short of explicitly contrasting with unifi_list_firewall_policies/rules, leaving the boundary to be inferred from the phrase 'referenced by firewall rules and policies'.

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

Usage Guidelines3/5

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

Usage is implied rather than stated: the agent can infer this tool is for inspecting groups that firewall rules and policies point at. There is no explicit when-to-use, when-not-to-use, or named alternative for resolving a group ID versus listing policies.

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