Skip to main content
Glama

Get guest portal settings

unifi_get_guest_portal_settings
Read-only

Retrieve guest portal and hotspot settings for a UniFi site, including authentication, session length, voucher/payment options, redirect, and allowed subnets.

Instructions

Get guest portal / hotspot settings: authentication method, session length, voucher/password/payment options, redirect, allowed subnets.

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

Input Schema

NameRequiredDescriptionDefault
siteNoSite name/ID as used in the API (e.g. 'default'). Defaults to the configured site. See unifi_list_sites.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.8.1

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 and openWorldHint=false, so the safety profile is covered. The description adds value by enumerating what the payload contains, which is useful given there is no output schema, but it says nothing about response shape, error behavior, or why idempotentHint is false on a pure getter.

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?

One front-loaded sentence naming the resource first and the covered fields second, with no filler wording. Every clause maps to something an agent would want to know about the payload.

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?

For a simple, optional-parameter read tool with full schema coverage, the field enumeration effectively substitutes for the missing output schema. Only the absence of any caller guidance keeps it short of complete.

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?

There is a single optional 'site' parameter and schema coverage is 100%, with the schema itself explaining the default and pointing to unifi_list_sites. The description adds nothing about the parameter, so the baseline of 3 applies.

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 ('Get') and a specific resource ('guest portal / hotspot settings'), then enumerates the concrete fields returned (authentication method, session length, voucher/password/payment options, redirect, allowed subnets). This distinguishes it from generic siblings like unifi_get_site_settings, though it never names them explicitly.

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

Usage Guidelines3/5

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

The usage is implied by the resource name and field list — an agent would know to call this when it needs hotspot/auth configuration — but there is no explicit when-to-use statement, no exclusion of alternatives such as unifi_get_site_settings, and no stated prerequisites.

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