hec_restore_events

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

No annotations are provided, so the description bears full responsibility. It mentions that the tool 'Returns task IDs to track progress', which is helpful for understanding async behavior. However, it omits critical aspects: whether the restore is immediate, idempotent, requires permissions, or has side effects. For a mutation tool, this is insufficient.

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?

Single sentence, direct and efficient. No unnecessary words. It provides the core purpose and key output (task IDs) in a concise manner.

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?

With only one parameter and no output schema, the description should compensate. It mentions returning task IDs but does not explain what a task ID represents, how to use it (e.g., with 'hec_get_task_status'), or any error states. Lacks details on the full process, leaving the agent with gaps.

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 description for eventIds as 'List of event IDs to restore'. The tool description adds no further meaning beyond 'by event ID'; it essentially rephrases the schema. With full schema coverage, baseline is 3, and no extra value is provided.

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?

Description clearly states 'Restore one or more previously quarantined events by event ID', specifying the action, target resource (events), and method (by ID). It correctly distinguishes from sibling tool 'hec_restore_emails' which handles emails.

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?

Description implies usage for restoring quarantined events but provides no explicit guidance on when to use this tool versus alternatives like 'hec_restore_emails' or when not to use it. The context of siblings suggests a distinction, but it's not stated.

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