unifi_list_user_groups

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

Without annotations, the description must disclose behavioral traits. 'List' implies a read-only operation, but the description does not explicitly state non-mutating behavior, authentication requirements, or return format. The added QoS context is useful but does not compensate for these omissions.

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 sentence that is front-loaded with the action and resource, and includes precise qualifiers (bandwidth rate-limiting, QoS max upload/download speed). Every word contributes to understanding.

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 zero-parameter list tool, the description fully specifies the resource type and purpose. Since no output schema exists, the description could mention the return structure, but 'List' implies a collection of user groups. It is adequately complete for the tool's simplicity.

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 zero parameters, so the schema is fully complete. The description's focus on the content of the list (bandwidth rate-limiting groups) adds semantic clarity beyond the empty schema. Baseline 4 is appropriate for 0-parameter tools.

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 'user groups' and adds clarifying context (bandwidth rate-limiting, QoS max upload/download speed). This distinguishes it from sibling tools like unifi_create_user_group and unifi_set_client_usergroup.

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 clearly implies the tool is for retrieving user groups and provides context about what those groups represent. It does not explicitly mention alternatives or when not to use it, but the operation is straightforward and the context is unambiguous.

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