Skip to main content
Glama
owine

UniFi Network MCP Server

by owine

List ACL rules

unifi_list_acl_rules
Read-only

Retrieve switch and access point ACL rules for a site, including matchers, action, and evaluation order. ACLs apply before firewall policies.

Instructions

List ACL rules (switch/AP-level access control lists, distinct from zone-based firewall policies) at a site. Returns: id, type (IPV4/MAC), name, enabled, action (ALLOW/BLOCK), description, protocolFilter, sourceFilter/destinationFilter matchers, enforcingDeviceFilter (which devices apply the rule), index (evaluation order — read-only; change it with unifi_reorder_acl_rules), metadata.origin. ACLs apply earlier in the path than firewall policies.

Input Schema

NameRequiredDescriptionDefault
limitNoNumber of records to return (API default: 25)
filterNoFilter expression
offsetNoNumber of records to skip
siteIdYesSite ID

Output Schema

NameRequiredDescriptionDefault
dataYes
countNo
limitNo
offsetNo
totalCountNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv2.15.0
    • 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: +{}
    • changedOutput schema / properties / data / items / properties / description / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
    • addedOutput schema / properties / data / items / properties / metadata / properties / configurable
      Added value: +{
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / data / items / properties / protocolFilter / anyOf
      Added value: +[
      +  {
      +    "items": {
      +      "type": "string"
      +    },
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • removedOutput schema / properties / data / items / properties / protocolFilter / items
      Removed value: -{
      -  "type": "string"
      -}
    • removedOutput schema / properties / data / items / properties / protocolFilter / type
      Removed value: -"array"
  2. Changed2 schema fields changedv2.13.0
    • changedInput schema / properties / limit / minimum
      Previous value: -1New value: +0
    • addedOutput schema / properties / data / items / properties / index
      Added value: +{
      +  "maximum": 9007199254740991,
      +  "minimum": -9007199254740991,
      +  "type": "integer"
      +}
  3. Addedv2.10.0
  4. Removedv2.9.0
  5. First observedv2.8.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint=true, destructiveHint=false), so the bar is lower, yet the description still adds real behavior: index is read-only evaluation order and must be changed via unifi_reorder_acl_rules, plus the domain note that ACLs apply earlier in the path than firewall policies. It doesn't mention pagination limits or filter syntax, which is a minor remaining gap.

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?

Front-loaded with the purpose and sibling distinction, then the field list. The enumerated 'Returns:' fields partly duplicate the output schema that already exists, making some of the text redundant, but overall it is dense and free of 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?

For a list tool with a read-only annotation set and an output schema, the description covers identity, scope, ordering semantics, and the reorder path. The only shortfall is that the return-field enumeration overlaps the output schema rather than adding new information.

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% (siteId, limit, offset, filter all documented in-schema), so the schema carries parameter meaning. The description only implies site scoping with 'at a site' and adds nothing about limit/offset/filter semantics, which is the expected baseline when the schema does the heavy lifting.

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?

Names a specific verb and resource ('List ACL rules') and immediately scopes it: 'switch/AP-level access control lists, distinct from zone-based firewall policies'. An agent can separate this from unifi_list_firewall_policies without opening either schema.

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?

The 'distinct from zone-based firewall policies' clause effectively routes the agent to the firewall-policy siblings when that is what's wanted, and the index note explicitly points to unifi_reorder_acl_rules for changing order. It stops short of stating prerequisites or when-not-to-use conditions, so it is clear context without full exclusions.

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