Skip to main content
Glama
owine

UniFi Network MCP Server

by owine

Get voucher

unifi_get_voucher
Read-only

Retrieve a specific UniFi hotspot voucher by site ID and voucher ID to view its details and status in the network.

Instructions

Get a specific hotspot voucher by ID (same fields as the list entry).

Input Schema

NameRequiredDescriptionDefault
siteIdYesSite ID
voucherIdYesVoucher ID

Output Schema

NameRequiredDescriptionDefault
idYes
codeNo
nameNo
expiredNo
createdAtNo
expiresAtNo
activatedAtNo
rxRateLimitKbpsNo
txRateLimitKbpsNo
timeLimitMinutesNo
authorizedGuestCountNo
authorizedGuestLimitNo
dataUsageLimitMBytesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv2.15.0
    • addedInput schema / properties / siteId / pattern
      Added value: +"^[A-Za-z0-9_-]{1,64}$"
    • addedInput schema / properties / voucherId / pattern
      Added value: +"^[A-Za-z0-9_-]{1,64}$"
    • changedOutput schema / additionalProperties
      Previous value: -falseNew value: +{}
  2. First observedv2.8.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds that the response has the same fields as the list entry, which is modest but useful behavioral context; it does not mention permissions, rate limits, or error behavior, so a 3 is appropriate given the annotation coverage.

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?

It is a single, front-loaded sentence with no wasted words. The key identifying information (specific voucher by ID) comes first.

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?

An output schema exists, annotations cover the safety profile, and both required parameters are fully documented in the schema. For a simple get-by-ID tool, the description is nearly complete; only explicit usage guidance relative to the list sibling is missing.

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%, with 'Site ID' and 'Voucher ID' documented in the schema itself. The description implies lookup by ID but adds no syntax, format, or constraints beyond what the schema already provides, so the baseline of 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?

The description states a specific verb (Get), resource (hotspot voucher), and scope (a specific voucher identified by ID). This clearly distinguishes it from the sibling unifi_list_vouchers, which lists rather than retrieves a single record.

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?

No explicit when-to-use guidance, prerequisites, or alternative recommendations are given. The clause 'same fields as the list entry' hints at redundancy with unifi_list_vouchers but does not tell the agent when to prefer this tool over the list tool.

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