cleanup_test_data

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

With no annotations, the description carries the full burden. It explains the pattern matching, the confirm parameter's role (dry-run vs actual deletion), and the domain scope. It lacks details on permissions or irreversibility, but the safety mechanism is disclosed, making it fairly transparent.

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 very concise: two short paragraphs with no fluff. The first paragraph states the core action, and the second lists parameters in a structured way. It is front-loaded with the purpose.

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?

Given the tool's complexity (3 parameters, output schema exists), the description covers the essentials: purpose, pattern, dry-run, and parameter details. It mentions the companion tool. However, it does not describe the output schema format, but that is handled separately. It is nearly complete.

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 0%, so the description must compensate. It fully explains each parameter: domain (target domain), username_prefix (same as generation), confirm (controls dry-run vs deletion). This adds significant meaning beyond the raw schema.

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 tool's purpose: remove test subscribers matching a pattern under a domain. It uses a specific verb ('Remove') and resource ('subscribers'), and distinguishes itself from siblings by mentioning it is a companion to gen_test_subscribers.

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 clear context: it is for cleaning up test data after generation with gen_test_subscribers. It also explains the dry-run safety mode. However, it does not explicitly list when not to use or mention alternative tools like subscriber_delete, so it lacks explicit exclusions.

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