Skip to main content
Glama

List ACL rules

unifi_list_acl_rules
Read-only

List switch MAC ACL rules that allow or block traffic between devices in a network, ordered by ACL index. Filter by network, site, or search to inspect access control.

Instructions

List switch ACL rules (MAC ACLs that allow or block traffic between devices inside one network, enforced by UniFi switches). Rules are processed in acl_index order. Needs Network 9.4+.

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

Input Schema

NameRequiredDescriptionDefault
rawNoReturn the full controller objects (large)
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
network_idNoOnly rules for this network ID

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

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, openWorldHint=false and idempotentHint=false, so the safety profile is covered. The description adds real context beyond them: the results come back in acl_index processing order (meaningful for ACL evaluation precedence) and the feature requires Network 9.4+ on the controller. It stops short of noting pagination or result size, which raw=true makes relevant, but that is covered partly by the parameter description.

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?

Three short sentences with zero filler, ordered from identity to domain definition to behavioral facts (ordering, version requirement). Nothing is repeated from the title or the schema.

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 five-parameter read-only list tool with no output schema, the definition covers what the resource is, how results are ordered, and a hard version prerequisite, while the schema handles parameter meaning and annotations handle safety. Only minor gaps remain: no mention of result volume or how raw changes the payload.

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 every one of the five parameters (raw, site, fields, search, network_id) is already documented in the schema; the baseline is 3. The description's only added signal is the implied scoping to a single network, which loosely maps to network_id but adds no syntax or formatting detail.

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?

States a specific verb and resource ('List switch ACL rules') and immediately defines the resource in domain terms ('MAC ACLs that allow or block traffic between devices inside one network, enforced by UniFi switches'). That definition is what separates it from the sibling rule-listing tools such as unifi_list_firewall_rules and unifi_list_traffic_rules, so an agent can choose without opening a schema.

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 definition makes clear it returns switch-level MAC ACLs scoped to one network, but it never says when to prefer this over the firewall/traffic rule siblings, nor does it give exclusions. The version prerequisite ('Needs Network 9.4+') is a useful gating condition but is not usage guidance per se.

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