unifi_list_sdwan_configs

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

With no annotations provided, the description carries the transparency burden. It does disclose the operation is read-only, tied to the API key's account, and only returns a subset of fields. It does not mention potential pagination, errors, or rate limits, but for a simple listing tool the core behavior is clearly disclosed.

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, focused sentence that front-loads the action and resource, then adds the scope and field limitation. Every word contributes useful information with no redundancy.

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?

Given that there is no output schema, the description adequately explains what will be returned (id, name, type only). It could mention pagination or point to get_sdwan_config for full data, but for a simple parameterless list operation the essential context is present.

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?

The tool has 0 parameters and the schema coverage is 100%, so there are no parameter semantics to clarify. The zero-parameter baseline of 4 applies; the description further clarifies the expected response fields, adding value beyond the schema.

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 uses a specific verb ('List') with a clear resource ('SD-WAN configurations'), explicitly scopes it to the account's configurations, and specifies the returned fields ('id, name, type only'). This makes it easy to distinguish from sibling get_sdwan_config or list_devices tools.

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?

The phrase 'List every' clearly conveys enumeration over all configurations, which implies use cases for browsing or overview rather than retrieving a specific config. However, it does not explicitly mention the sibling get_sdwan_config as the alternative when full details are needed, so guidance is adequate but not fully explicit.

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