unifi_set_wlan_password

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

With no annotations provided, the description carries the full burden of disclosing behavioral traits, but it only states the core action without mentioning side effects (e.g., disconnecting connected clients), permission requirements, password validation rules, or reversibility. It is not misleading, but it is largely non-transparent about consequences and prerequisites.

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 concise sentence with no wasted words. It is appropriately front-loaded and easy to parse. While more detail could be added, the structure is efficient and clear.

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?

This is a mutation tool with no annotations and no output schema, and the description provides only minimal functional information. It lacks usage guidelines, parameter clarifications, and behavioral side effects. Given the existence of a similar sibling (unifi_update_wlan), the description is insufficient for an agent to confidently select and invoke this tool correctly.

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 schema has 0% description coverage, so the description must explain the parameters. It clearly indicates that 'password' is the new WPA passphrase, but it does not explicitly explain that 'wlan_id' is the identifier of the target Wi-Fi network or how it should be obtained (e.g., from 'unifi_list_wlans'). The phrase 'a Wi-Fi SSID network' vaguely implies the target but does not map to the parameter name.

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 action ('update WPA passphrase') and the resource ('a Wi-Fi SSID network'), making the tool's purpose specific and understandable. However, it does not explicitly distinguish this tool from the sibling 'unifi_update_wlan', which could also potentially update WLAN settings, so it lacks explicit sibling differentiation.

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 no guidance on when to use this tool versus alternatives like 'unifi_update_wlan'. It does not mention prerequisites, typical scenarios, or situations where this tool should not be used. The implied usage is for changing a Wi-Fi password, but this is not explicitly stated.

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