Skip to main content
Glama

List hotspot vouchers

unifi_list_vouchers
Read-only

Lists UniFi hotspot vouchers with code, note, duration, quota, usage, status, rate and data limits, and creation time to audit or manage guest access.

Instructions

List hotspot vouchers with code, note, duration, quota and times used, status, rate and data limits, and creation time. For who redeemed them use unifi_list_guest_authorizations.

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

Input Schema

NameRequiredDescriptionDefault
siteNoSite name/ID as used in the API (e.g. 'default'). Defaults to the configured site. See unifi_list_sites.
limitNoMaximum items to return (default 200)
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 200"New value: +"Maximum items to return (default 200)"
    • 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
Behavior3/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 safety profile needs no restatement. The description adds value by disclosing which attributes each voucher carries, but says nothing about ordering, pagination beyond the schema default, or whether inactive/expired vouchers are included.

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?

Two sentences, zero filler: the first front-loads what is returned, the second handles routing. Every clause earns its place and the agent can act after one read.

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?

With no output schema, the description correctly compensates by enumerating the returned fields, which is the key missing structured information. What remains unstated is result ordering and how the fields projection interacts with the listed attribute names, but the definition is otherwise sufficient for a parameterized list tool.

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, limit, fields, and search are fully documented in the structured data. The description adds no filter syntax, dot-path, or search-targeting nuance beyond naming returned attributes, so baseline 3 applies.

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 hotspot vouchers") and enumerates the payload the agent will get back: code, note, duration, quota, times used, status, rate/data limits, creation time. It also explicitly distinguishes itself from the sibling that answers the adjacent question (redemption).

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?

Explicitly routes the agent: "For who redeemed them use unifi_list_guest_authorizations" — a clear use-this-instead rule for the most likely confusion in this domain. It lacks broader when-to-use framing (e.g. retrieving a single voucher vs. listing), but the main sibling boundary is unambiguous.

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