unifi_get_sdwan_config

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

With no annotations provided, the description carries the burden for behavioral disclosure. It notes the data is 'admin-gated' and indicates network-topology data, but does not mention security implications, potential side effects, or rate limits. Since it's a read operation, that's expected, but the description adds little beyond what the name implies.

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

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

The description is a single, information-dense sentence that front-loads the main purpose and enumerates the key content. No wasted words.

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

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

For a read-only retrieval tool with one parameter and no output schema, the description is quite complete. It lists what the topology includes and notes the admin-gating. The only gap is not mentioning that the output format might have nesting, but that's minor given the low complexity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already documents the id parameter. The description adds that the id is from unifi_list_sdwan_configs, which is useful context beyond the schema. This justifies a slightly above-baseline score.

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

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

The description clearly states the tool retrieves the full topology for one SD-WAN configuration, enumerating specific contents (variant, settings, hubs/spokes, site/host IDs, network IDs, routed subnets). This distinguishes it from sibling tools like unifi_get_sdwan_config_status and unifi_list_sdwan_configs.

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

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

It implies use for retrieving a specific configuration's topology, and the parameter description mentions id is as returned by unifi_list_sdwan_configs, which gives context. However, it does not explicitly state when not to use it or contrast with alternatives like unifi_get_sdwan_config_status.

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