list_wlan_configs

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

The description goes beyond basic functionality by warning that results are 'Returned verbatim, including plaintext x_passphrase credential fields,' which alerts to sensitive data exposure. Since no annotations are present, this disclosure carries full weight, though it does not explicitly state read-only behavior or pagination.

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 two sentences plus parameter definitions, no filler. The primary purpose is front-loaded, followed by parameter formats and then the critical credential exposure note.

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 tool with only two required string parameters and no output schema, the description covers all essentials: what is listed, how to specify the target, and notable return characteristics. Nothing critical is missing for a correct invocation.

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 input schema only declares 'host' and 'site' as strings with no descriptions. The description compensates fully by defining 'host' as 'console name, ID, or composite ID (MAC:numericId format)' and 'site' as 'site name or ID,' so an agent knows exactly what values are acceptable.

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 states a specific action: 'List per-SSID WLAN configurations... for a site.' It names the resource (WLAN configurations), the granularity (per-SSID), and the fields (security, band steering, rate limits). The plural 'configs' in the tool name and the 'List' verb distinguish it from the sibling get_wlan_config.

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 description provides clear context that this tool is for retrieving WLAN configuration lists scoped to a site, and it explains how to format the host and site parameters. However, it does not explicitly state when to prefer this tool over siblings like get_wlan_config or update_wlan_config, nor does it mention exclusions.

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