stalwart_allow_ip

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

With no annotations, the description carries the full burden of behavioral disclosure. It states the effect (bypass spam checks) and parameter constraints (expiry format), but does not mention persistence, interaction with block lists, or whether it overrides existing blocks. Adequate but not comprehensive.

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 two lines of prose followed by a compact argument list. Every sentence and bullet earns its place, with no filler or redundant restating of the tool name.

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?

For a simple allowlist action with an output schema present, the description covers the core behavior and parameter semantics. It could mention how an allowlisted IP interacts with blocked IPs, but this is a minor gap given the tool's simplicity.

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?

Despite 0% schema coverage, the description adds meaning to all three arguments: address is 'IP or CIDR', reason is optional, and expires_at is 'optional ISO 8601 UTC expiry'. This provides format and optionality information beyond the bare string schema.

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 opening sentence 'Allowlist an IP address (bypass spam checks)' uses a specific verb and resource, and the parenthetical clearly differentiates it from blocking-related siblings like stalwart_block_ip, stalwart_unblock_ip, and stalwart_unallow_ip.

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 phrase 'bypass spam checks' provides clear context for when this tool is appropriate. It does not explicitly mention alternatives or exclusions, but the intended use case is unambiguous given the sibling tool names.

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