Skip to main content
Glama
owine

UniFi Network MCP Server

by owine

Get DNS policy

unifi_get_dns_policy
Read-only

Retrieve a DNS policy by site and policy ID to inspect its configured fields for review or troubleshooting.

Instructions

Get a specific DNS policy by ID (same fields as the list entry).

Input Schema

NameRequiredDescriptionDefault
siteIdYesSite ID
dnsPolicyIdYesDNS policy ID

Output Schema

NameRequiredDescriptionDefault
idYes
portNo
textNo
typeNo
domainNo
weightNo
enabledNo
serviceNo
metadataNo
priorityNo
protocolNo
ipAddressNo
ttlSecondsNo
ipv4AddressNo
ipv6AddressNo
serverDomainNo
targetDomainNo
mailServerDomainNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed15 schema fields changedv2.15.0
    • addedInput schema / properties / dnsPolicyId / pattern
      Added value: +"^[A-Za-z0-9_-]{1,64}$"
    • addedInput schema / properties / siteId / pattern
      Added value: +"^[A-Za-z0-9_-]{1,64}$"
    • changedOutput schema / additionalProperties
      Previous value: -falseNew value: +{}
    • addedOutput schema / properties / ipAddress
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / ipv6Address
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / mailServerDomain
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / metadata / properties / configurable
      Added value: +{
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / port
      Added value: +{
      +  "type": [
      +    "number",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / priority
      Added value: +{
      +  "type": [
      +    "number",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / protocol
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / serverDomain
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / service
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / targetDomain
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / text
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / weight
      Added value: +{
      +  "type": [
      +    "number",
      +    "null"
      +  ]
      +}
  2. First observedv2.8.0

TDQS

C2.9/5.0
Behavior2/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 fully covered. The description adds only that fields match the list entry, which is a minor return-shape note already implied by the existing output schema; no auth, error, or rate-limit context is provided.

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?

A single short sentence with the key action front-loaded and no filler. The parenthetical about list-entry fields is the only marginally wasteful element given an output schema exists.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-parameter read tool with a full output schema and complete annotations, the minimum viable information is present. It stops short of stating the relationship to the list tool or any failure conditions, leaving clear but minor gaps.

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%, so the schema already documents siteId and dnsPolicyId. The description's 'by ID' hints at the dnsPolicyId parameter but adds no syntactic or format detail beyond the schema; baseline 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 and resource: retrieving one DNS policy by ID. The name plus description clearly distinguish it from the sibling unifi_list_dns_policies. The trailing parenthetical adds little but doesn't obscure the purpose.

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 statement of when to use this versus unifi_list_dns_policies or any other sibling, and no prerequisites mentioned (e.g., needing a siteId and an ID obtained from the list call). Usage is only inferable from the tool name.

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