Skip to main content
Glama
Sign In
UniFi Network MCP Server

UniFi Network MCP Server

by owine
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

List vouchers

unifi_list_vouchers
Read-only

List hotspot/guest-portal vouchers at a site to view codes, expiration status, usage limits, and guest counts. Filter by expired to bulk-find stale vouchers.

Instructions

List hotspot/guest-portal vouchers at a site. Returns: id, code, name, createdAt, activatedAt (when first guest used it), expiresAt, timeLimitMinutes, dataUsageLimitMBytes, rxRateLimitKbps, txRateLimitKbps, authorizedGuestLimit, authorizedGuestCount, expired. Use filter like 'expired.eq(true)' to bulk-find stale vouchers.

Input Schema

NameRequiredDescriptionDefault
limitNoNumber of records to return
filterNoFilter expression (e.g., 'expired.eq(true)')
offsetNoNumber of records to skip
siteIdYesSite ID

Output Schema

NameRequiredDescriptionDefault
dataYes
countNo
limitNo
offsetNo
totalCountNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv2.15.0
    • changedInput schema / properties / limit / default
      Previous value: -100New value: +25
    • changedInput schema / properties / limit / description
      Previous value: -"Number of records to return (default: 100, max: 1000)"New value: +"Number of records to return"
    • 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: +{}
  2. Changed1 schema field changedv2.13.0
    • changedInput schema / properties / limit / minimum
      Previous value: -1New value: +0
  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 declare readOnlyHint=true, openWorldHint=false, destructiveHint=false, so the safety profile is covered. The description adds genuinely new context by enumerating the returned fields and clarifying field meaning (activatedAt = when first guest used it, expired flag), aiding interpretation beyond the annotations.

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-loads the verb and resource, then the return list, then the filter tip. Slightly long on the return-field enumeration, but each item is information-bearing and the structure is easy to scan.

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?

Given an output schema exists, the description needn't detail return values, yet it does, so nothing is missing. Combined with full schema coverage and annotations, an agent has everything needed to call it correctly.

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% and the filter parameter's own schema description already contains the 'expired.eq(true)' example. The description only restates the filter's purpose (bulk-find stale vouchers) and adds nothing about limit/offset pagination, so baseline 3 is correct.

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 (List) with a clearly scoped resource (hotspot/guest-portal vouchers at a site). This distinguishes it from the sibling unifi_get_voucher, which fetches a single voucher, without needing to open 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?

Provides a concrete usage directive: use filter 'expired.eq(true)' to bulk-find stale vouchers, which tells the agent a real task this tool handles. It stops short of naming alternatives or stating when-not to use it, so not a 5.

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

Deploy Server

Other Tools