Skip to main content
Glama

unifi_gen_getsdwanconfigstatus

unifi_gen_getsdwanconfigstatus
Read-onlyIdempotent

Retrieves the current status of an SD-WAN configuration by its unique ID, helping you verify deployment state and troubleshoot configuration issues.

Instructions

Get SD-WAN Config Status - generated from developer.ui.com/site-manager/v1.0.0/getsdwanconfigstatus

Input Schema

NameRequiredDescriptionDefault
idYesUnique identifier of the SD-WAN configuration

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

C2.5/5.0
Behavior2/5

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

Annotations already declare readOnly, idempotent, openWorld, and non-destructive, so the safety profile is covered. The description adds no behavioral context of its own — no indication of what status fields come back, whether the id refers to a config or a site, or whether results are cached/live. The only added text is a provenance URL.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Very short and front-loaded with the purpose, which is good, but the trailing 'generated from developer.ui.com/...' provenance string occupies a meaningful share of an already minimal description without helping the agent decide or invoke.

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

Completeness2/5

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

No output schema exists, yet the description never says what a 'config status' response contains or how it differs from the config itself. For a tool whose whole value is a status payload, that is a substantive gap even though the single parameter is well documented.

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% and the single 'id' parameter is documented as the SD-WAN configuration identifier, so the baseline applies. The description adds no extra meaning about where that id comes from (presumably listsdwanconfigs) or how it is formatted.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Get SD-WAN Config Status'), but the resource is ambiguous next to siblings like unifi_gen_getsdwanconfigbyid, unifi_gen_listsdwanconfigs, and unifi_sm_get_sdwan_config_status. Nothing explains what a 'config status' is versus a config, so the agent cannot confidently pick this tool from the family without opening schemas.

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 prerequisites, and no mention of the closely named alternatives (getsdwanconfigbyid, listsdwanconfigs, unifi_sm_get_sdwan_config_status). The agent must infer selection from the name alone.

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

Deploy Server

Other Tools