Skip to main content
Glama

unifi_gen_getvouchers

unifi_gen_getvouchers
Read-onlyIdempotent

Retrieve a paginated list of UniFi vouchers, with optional filtering and offset controls to find specific voucher records.

Instructions

List Vouchers - generated from developer.ui.com/network/v11.0.97/getvouchers

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

Input Schema

NameRequiredDescriptionDefault
limitNo
filterNo
offsetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

C2.6/5.0
Behavior2/5

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

Annotations already state readOnlyHint, idempotentHint and non-destructive, so the safety profile is covered. The description adds nothing beyond a source-doc URL: it does not mention pagination via limit/offset, how filter expressions are interpreted, or result ordering, which are the real behavioral unknowns for a 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?

The definition is short and front-loaded with the verb+resource, which is good. The trailing 'generated from developer.ui.com/...' clause consumes space without telling the agent anything actionable.

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 no output schema, no parameter documentation and no behavioral notes, an agent cannot tell what a voucher record looks like, whether results are paged, or how to narrow them. The one-line description is not sufficient for a filtered list tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% for three parameters (limit, filter, offset), and the description supplies no semantics at all. The names hint at conventional paging and filtering, but format, filter syntax, and defaults are left entirely undocumented.

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 Vouchers'), so the agent knows exactly what is returned. However, it does not distinguish this from close siblings such as unifi_net_list_vouchers or unifi_gen_getvoucher, which likely do the same thing through a different API surface.

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 guidance on when to use this versus unifi_net_list_vouchers or unifi_gen_getvoucher, and no prerequisites or scope conditions are given. The agent must guess which voucher-listing variant to call.

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