fail2ban_unban

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

With no annotations, the description carries the full behavioral burden, yet it only states the purpose. It doesn't disclose that this mutates firewall/ban state, that it defaults to a dry run requiring apply/planHash, or any permission or failure behavior; the dry-run mechanism is only visible in the schema.

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?

A single front-loaded sentence: verb and resource lead, scope follows, and the motivating example closes without waste. Compact and easy to scan, though the trailing example is optional.

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 5-parameter mutation tool with no annotations and no output schema, the description covers only purpose and a hint of context. The schema carries the critical dry-run/planHash mechanics, but behavioral facts an agent needs (state changes, error cases, whether the ban must exist) are absent.

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 description coverage is a middling 60%, with ip and jail carrying only patterns and no prose. The description partially compensates by clarifying the jail parameter ('all jails, or one') and the host targeting ('on hosts'), but says nothing about apply/planHash/target beyond what the schema already documents.

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 gives a specific verb (unban), resource (an IP in fail2ban), and scope (all jails, or one) applied across hosts. An agent can tell exactly what this does, and the parenthetical disambiguates the jail scoping rather than leaving it to the schema alone.

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?

It supplies a clear use context — 'after locking yourself out or a false positive' — which frames when an agent should reach for this tool. It does not name explicit exclusions or alternatives (e.g. ban-side tools), so it stops short of full routing guidance.

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