Skip to main content
Glama

Get site settings

unifi_get_site_settings
Read-only

Retrieves site-wide UniFi settings by key, such as country, NTP, SNMP, guest access, or IPS; omit the key to list all available setting keys.

Instructions

Get site-wide settings. Each setting is an object identified by key, e.g. mgmt (auto-upgrade, LEDs, SSH), country, locale, ntp, snmp, mdns (multicast DNS), rsyslogd (remote syslog), connectivity, guest_access, ips, dpi, usg (gateway: DNS, geo-IP, UPnP...), radius, network_optimization, super_mgmt (controller-wide, including auto-backup). Omit key to list all keys.

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

Input Schema

NameRequiredDescriptionDefault
keyNoSetting key to return in full; omit to list available keys
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 by structured data. The description adds valuable shape information — that results are keyed objects and that some keys (super_mgmt) span the whole controller rather than one site — but it says nothing about how large or paged the full listing is when `key` is omitted.

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?

Two sentences: the action and return shape first, then the key catalog, then the omit-to-list rule. The long parenthetical enumeration is dense but earns its space because no output schema exists to document what lives under each key.

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?

With no output schema, the description carries the burden of explaining the return shape and does so (keyed objects, per-key contents, controller-wide caveat for super_mgmt), and it delegates the `site` argument to unifi_list_sites. The only residual gap is the absence of a bound on the full listing when no key is supplied.

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%, so the baseline is 3, and the description does exceed that slightly by hinting at the contents of individual keys (mgmt = auto-upgrade/LEDs/SSH, usg = DNS/geo-IP/UPnP). Still, these are illustrative hints rather than per-key semantics, and the `site` parameter's guidance lives entirely in the schema.

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?

The description gives a specific verb and resource ("Get site-wide settings") and immediately explains the internal structure — each setting is a keyed object. The enumeration of keys (mgmt, country, ntp, ips, usg, etc.) makes the scope concrete and distinguishes it from narrower siblings like unifi_get_security_settings or unifi_get_guest_portal_settings, though it never names those alternatives explicitly.

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?

"Omit `key` to list all keys" encodes a clear two-step discovery workflow, which is real usage guidance for a keyed-settings tool. What is missing is any stated condition for choosing this tool over the domain-specific settings siblings; the reader must infer that from the word "site-wide."

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