Skip to main content
Glama

List guest authorizations

unifi_list_guest_authorizations
Read-only

Lists guest portal and hotspot authorizations, newest first, returning client MAC/IP, method, voucher code, start/end times, bytes, and expired status for a chosen lookback window.

Instructions

List guest portal/hotspot authorizations, newest first (default last 168 hours): client MAC and IP, method, voucher code, start and end, bytes and expired flag.

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

Input Schema

NameRequiredDescriptionDefault
siteNoSite name/ID as used in the API (e.g. 'default'). Defaults to the configured site. See unifi_list_sites.
hoursNoLook back this many hours (default 168)
limitNoMaximum items to return (default 100)
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. Changed3 schema fields changedv0.9.1
    • addedInput schema / properties / fields / description
      Added value: +"Only return these fields per item (dot paths, e.g. uplink.name)"
    • changedInput schema / properties / limit / description
      Previous value: -"Default 100"New value: +"Maximum items to return (default 100)"
    • addedInput schema / properties / search / description
      Added value: +"Case-insensitive substring match on names, MACs, IPs and similar"
  2. First observedv0.8.1

TDQS

A3.5/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 genuine value beyond that: result ordering (newest first) and the default 168-hour window. It does not cover result-size/truncation behavior or how the 'expired' flag should be interpreted, which are the remaining behavioral gaps.

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?

A single front-loaded sentence with no filler; the trailing colon list of returned fields earns its place because there is no output schema. Slightly dense but well ordered.

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 read-only list tool with a fully documented schema and no output schema, the field inventory compensates for the missing return spec. Minor incompleteness remains around pagination/truncation and ordering guarantees when 'hours' is overridden.

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, hours, limit, fields and search are already documented in the schema. The description restates the 168-hour default (already in the schema) and does not add syntax or interaction notes, so baseline 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?

States a specific verb and resource ('List guest portal/hotspot authorizations') and adds ordering ('newest first') plus the default time window. The resource is clearly distinct from the nearest potentially confusable sibling, unifi_list_hotspot_operators, though that sibling is never named.

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 default 168-hour lookback implies the common usage context, but there is no explicit guidance on when to choose this over alternatives, no when-not conditions, and no note about how to widen the window or what to do if results are truncated.

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