hec_quarantine_emails

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

Description adds value beyond annotations by explaining the reversible nature, impact on user access, and return of task IDs. Annotations already indicate destructive and idempotent, but the description clarifies the 'reversible via restore' aspect and the need for user confirmation.

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 plus a warning emoji. First sentence states purpose, second adds reversibility and task IDs, third requires confirmation. No extraneous words; front-loaded and efficient.

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 simple tool with 2 parameters and no output schema, the description covers input (entity IDs), effect (quarantine, affects access), return (task IDs), and required confirmation. Missing minor details like how to obtain entity IDs, but adequate overall.

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 covers both parameters with descriptions. The description adds no new details about parameters (e.g., format of entity IDs). Baseline of 3 is appropriate given 100% schema coverage.

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 action (quarantine) and resource (specific email entities by entity ID). It distinguishes from sibling hec_quarantine_events by specifying emails, and mentions reversibility for differentiation from irreversible actions.

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 warns of high impact and instructs to confirm with user before invoking. Mentions reversibility via restore, implying when not to use (if unsure). However, no explicit alternatives or exclusions are given.

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