createUnsubscribe

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

Discloses that it writes live data, is site-wide and all-or-nothing, and affects global unsubscribe list. Annotations are minimal (readOnlyHint false, destructiveHint false) but the description adds important behavioral context beyond 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?

Well-structured with bullet-like sections (Use when, Required, Enums, See also). Around 120 words, no unnecessary fluff, though it repeats 'email is the only meaningful input' twice.

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?

Covers usage, scope, and alternatives well, but fails to mention what the tool returns (no output schema). For a create tool, the agent might expect info on the created record or confirmation.

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%, but the description adds extra meaning: emphasizes that email is the only meaningful input, explains the scope of unsubscribe, and clarifies the definitive enum values (0,1). This goes beyond the schema descriptions.

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?

Clearly states the tool creates a new unsubscribe record for an email, with specific verb 'create' and resource 'unsubscribe'. Differentiates from sibling tools like updateUnsubscribe and deleteUnsubscribe.

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 says when to use ('programmatically opting a member out of emails') and provides alternative ('See also: updateUnsubscribe') with clear context that BD also does this automatically on click.

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