Test Webhook

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

Annotations already indicate destructiveHint=true and idempotentHint=true. The description 'Queue a test event' adds minimal behavioral detail beyond these annotations—it does not clarify whether the event is immediately sent, what side effects occur, or if it creates a delivery record. Description fails to add meaningful context about the tool's behavior.

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 a single concise sentence that communicates the tool's purpose without redundancy or extraneous information. It is front-loaded and every word earns its place.

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?

The description is adequate for a straightforward tool but lacks context about prerequisites (e.g., webhook must exist) and what a 'test event' entails (e.g., payload, timing). Output schema exists, so return values don't need coverage, but the missing usage context reduces completeness.

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?

Input schema has 100% description coverage for both parameters (id and idempotency_key), so the schema already documents them. The tool description does not add any parameter-specific information beyond what the schema provides, warranting a baseline score of 3.

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 'Queue a test event for a webhook endpoint.' clearly states the action (queue a test event) and the resource (webhook endpoint). It effectively distinguishes this tool from siblings like shipmail_create_webhook, shipmail_delete_webhook, and shipmail_replay_webhook_delivery, which handle different operations on webhooks.

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 implies usage for testing a webhook but does not provide explicit guidance on when to use this tool vs. alternatives like shipmail_replay_webhook_delivery or prerequisites such as the webhook needing to exist. The usage context is implied but not clearly articulated.

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