aiworkhub_dashboard_terminal_log_purge

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

Goes well beyond the destructiveHint annotation by disclosing the confirm=True gate, the expired-restore-deadline precondition on manual batches, that the batch directory is removed, that an audit record is appended, and that storage telemetry is invalidated. These are real side effects an agent cannot infer from annotations.

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?

Two sentences, front-loaded with the 'DESTRUCTIVE:' warning before any other detail, and every clause carries operative information (precondition, alternative, side effects). No filler.

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?

An output schema exists so return values need no explanation, and the schema plus description together cover both parameters fully. For a two-parameter irreversible mutation, the agent has everything needed to decide and to call it 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?

Schema coverage is 100%, so the baseline is 3; the description adds a validity condition not in the schema — the batch must be expired and, for manual batches, past its restore deadline. It doesn't add anything for batch_id format beyond 'identifier', but the added precondition earns a step above baseline.

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?

States a specific verb and resource ('permanently delete one expired terminal-log quarantine batch from disk') with a scope limiter ('one expired batch'), so the agent knows exactly what unit of work it performs. It is clearly distinct from the sibling preview, restore, and quarantine tools.

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?

Explicitly routes the agent: inspect with aiworkhub_dashboard_terminal_log_retention_preview first, and use aiworkhub_dashboard_terminal_log_restore instead while the undo window is active. Both the alternative tool and the condition that selects it are named.

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