pmg_quarantine_welcomelist_add

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

Discloses mutation type, dry-run behavior, confirmation requirement, and underlying API path. No annotations provided, so description compensates well.

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?

Three concise sentences covering purpose, execution, and technical details. Front-loaded with essential information.

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 mutation, dry-run, config, and optional scope. Output schema exists, so lack of return value description is acceptable. Provides API path for verification.

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?

Adds meaning beyond schema for pmail (optional per-user scope) and confirm (execution flag). Schema coverage low (25%), but description clarifies key parameters.

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 'add an address to the quarantine welcomelist' with a specific verb and resource. Distinct from siblings like remove and list.

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?

Mentions dry-run default, confirm=True to execute, and config requirement. Provides context for when to use confirm, though no direct comparison to alternatives.

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