Skip to main content
Glama

List dynamic DNS

unifi_list_dynamic_dns
Read-only

Lists a UniFi gateway's dynamic DNS entries so you can review provider, hostname, login, server, and WAN interface details, with passwords redacted.

Instructions

List the gateway's dynamic DNS entries, which keep a public hostname pointed at the WAN IP: provider service, hostname, login, server and WAN interface (passwords redacted).

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

Input Schema

NameRequiredDescriptionDefault
siteNoSite name/ID as used in the API (e.g. 'default'). Defaults to the configured site. See unifi_list_sites.
fieldsNoOnly return these fields per item (dot paths, e.g. uplink.name)
searchNoCase-insensitive substring match on names, MACs, IPs and similar

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.9.1
    • addedInput schema / properties / fields / description
      Added value: +"Only return these fields per item (dot paths, e.g. uplink.name)"
    • addedInput schema / properties / search / description
      Added value: +"Case-insensitive substring match on names, MACs, IPs and similar"
  2. First observedv0.8.1

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is largely covered. The description adds genuinely useful behavioral context beyond them: it explains the semantic role of DDNS entries and discloses that passwords are redacted in the output, which tells the agent not to expect full credentials. It omits pagination and ordering behavior, but for a small gateway config list that is a minor gap.

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?

A single sentence that front-loads the core action and packs the explanatory gloss and the returned-field list into the same clause, with no filler. Nothing can be removed without losing information.

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?

No output schema exists, so the description carries the burden of describing the return shape, and it does so by listing the returned fields and noting password redaction. Combined with fully documented parameters and a clear read-only annotation, an agent has what it needs to call this correctly. Explicit guidance on when to prefer it over unifi_list_dns_records is the remaining gap.

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, fields, and search each documented including format hints like dot paths and case-insensitive substring matching. The description adds no parameter-level meaning whatsoever, 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?

Specific verb plus resource: 'List the gateway's dynamic DNS entries,' with a clarifying gloss that these entries keep a public hostname pointed at the WAN IP. It also enumerates the fields returned (provider, hostname, login, server, WAN interface), so the agent knows exactly what domain object this is. It does not explicitly distinguish itself from the sibling unifi_list_dns_records, which an agent could plausibly confuse with DDNS entries.

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 when-to-use guidance, no mention of prerequisites such as a configured site, and no pointer to alternative tools. The only hint is the schema's reference to unifi_list_sites for discovering the site value, which sits in the input schema rather than the description. The read-only list nature implies usage but the description asserts nothing.

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