Skip to main content
Glama

List AP groups

unifi_list_ap_groups
Read-only

List UniFi access point groups with IDs, names, member AP MACs, device counts and default flags to see which APs broadcast each WiFi network.

Instructions

List access point groups (id, name, member AP MACs, device count, default flag), which choose the APs that broadcast each WiFi network. Network 7.x+ (v2 API).

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_ap_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

A4/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 the safety profile is covered. The description adds value beyond that by naming the concrete fields returned and flagging the API version requirement, which affects whether the call can succeed at all; only pagination/result-size behavior is left unspecified.

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 giving the verb, resource, return fields, and semantic purpose, followed by a short version tag. Nothing is redundant with the title and no sentence is wasted.

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?

There is no output schema, but the description compensates by enumerating the key returned fields, and the version constraint covers a major failure mode. For a three-parameter read-only list tool this is nearly complete, with only result-set size or pagination behavior unaddressed.

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%, and all three parameters (site, fields, search) are documented in the schema including the fields dot-path syntax and search matching behavior. The description adds no parameter-level information, so the baseline 3 applies when the schema carries the burden.

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?

The description states a specific verb and resource ('List access point groups') and enumerates the returned fields (id, name, member AP MACs, device count, default flag). It also explains what the resource means — groups that choose which APs broadcast each WiFi network — which cleanly separates it from siblings such as unifi_list_firewall_groups or unifi_list_devices.

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?

The description supplies meaningful applicability context with the 'Network 7.x+ (v2 API)' constraint, telling the agent when this call is valid. However, it gives no explicit when-to-use guidance relative to alternatives, such as using unifi_list_devices to resolve AP names for the member MACs, and no exclusions.

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