spamtitan_manage_allowlist

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

No annotations provided, so description must disclose behavior. It only states basic function and effect, but omits details like idempotency, duplicate handling, removal matching, permissions, or output format on 'list'.

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 with clear structure: first states action and resource, second explains consequence. No unnecessary words.

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?

Tool is simple with 3 params, 1 required, enum for action. Description covers purpose and effect. Lacks info on 'list' output format but overall adequate for a straightforward management tool.

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%, so schema fully describes parameters. Description adds context about the overall effect (bypass filtering) but no additional parameter-specific meaning.

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 the tool manages allowlist entries (add/remove) in SpamTitan and explains the effect (bypass spam filtering). It distinguishes from sibling spamtitan_manage_blocklist by specifying allowlist.

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?

Implied usage from name and sibling tools, but no explicit guidance on when to use vs blocklist, no prerequisites or exclusions. Schema enum covers actions but description lacks context.

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