Skip to main content
Glama

List vouchers

unifi_net_list_vouchers
Read-onlyIdempotent

Lists hotspot vouchers configured on the current site, with pagination and filtering support.

Instructions

Hotspot vouchers configured on the current site.

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

Input Schema

NameRequiredDescriptionDefault
limitNoItems per page, at most 1000 (vendor default applies when unset)
filterNoVendor filter expression
offsetNoNumber of items to skip (vendor default 0)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

C2.5/5.0
Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so safety is covered. The description adds only the site-scoping fact; it says nothing about pagination behaviour, result ordering, or the practical consequence of the limit/offset defaults despite being a paginated list endpoint.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

It is a single fragment with no wasted words, but it is so terse that it omits the action verb and reads as a label rather than instructions. Brevity here costs information rather than demonstrating economy of expression.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With three optional parameters, no output schema, and no return-value documentation anywhere else, the description should say what a voucher record contains or how results are paged. Instead it leaves the agent to infer everything beyond the resource name and site scope.

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 (limit, filter, offset) are documented with their vendor defaults in the schema itself. The description adds no additional meaning about filter expression syntax or paging strategy, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description is a noun phrase naming the resource and its scope ('Hotspot vouchers configured on the current site'), but supplies no verb of its own — the 'list' action comes only from the title. It also does not distinguish itself from voucher-reading siblings such as unifi_net_get_voucher or unifi_gen_getvouchers.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no statement of when to use this tool versus the singular get_voucher or the gen_* voucher list equivalents, and no prerequisites or exclusions are given. The agent must infer that this enumerates all vouchers on the active site.

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