Unban MQTT Client

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

Annotations already declare destructiveHint=true and readOnlyHint=false, so the description's '[DESTRUCTIVE]' prefix duplicates that. It adds the behavioral outcome that the client 'may connect again', but does not disclose other traits such as idempotency (already annotated) or what happens if the ban does not exist. The extra context is minimal but not contradictory.

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 front-loads the destructive warning and immediately states the action and its effect. There is zero redundancy or wasted words, and it is appropriately sized for a simple two-parameter tool.

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?

The tool is simple with full schema and annotations providing safety and parameter details. The description explains the core purpose and outcome, and an output schema handles return values. Missing context includes explicit guidance on matching subject_type to the original ban and potential error conditions, but these are partially covered by the schema. Overall, it is adequately complete for a low-complexity destructive action.

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%, with both parameters fully described in the input schema (who as 'The exact banned value' and subject_type as an enum with a clarifying note). The description adds no parameter-specific meaning beyond the tool's purpose, so it stays at the baseline of 3.

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 'Lift a ban so the client may connect again' uses a specific verb (Lift) and resource (ban) and clearly distinguishes it from siblings like emqx_ban (which creates bans) and emqx_list_banned (which lists bans). The outcome is immediately understandable.

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?

No guidance is given about when to use this tool versus alternatives like emqx_ban or emqx_list_banned. It implies usage by saying 'Lift a ban' but does not explicitly state prerequisites, such as needing to know the exact banned value and subject_type, nor does it mention that this should be used to reverse a specific ban.

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