yd_blocked_ips_update

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

Discloses the IP limit and type restriction, but with no annotations, it should cover more behavioral aspects like whether the tool replaces existing blocked IPs or appends, error handling, and permission requirements. These gaps make it insufficient for a mutation tool.

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, no filler, directly conveys purpose and key constraints. Every word is necessary.

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?

Given the tool's simplicity (two required params, no output schema), the description covers basic constraints but lacks details about side effects (overwrite vs. append), response behavior, and error cases. Adequate but not complete.

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%, and the description adds value beyond schema by specifying the 'max 25' limit and 'exact IPs only' constraint. This helps the agent understand parameter boundaries not captured in 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 description clearly states the action (set blocked IPs), the resource (campaign), and key constraints (max 25, exact IPs only). It is specific and easy to understand.

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?

Provides constraints (max 25, no subnets) but no explicit guidance on when to use this tool versus alternatives (e.g., updating or deleting individual IPs). Lacks when-not or alternative tool references.

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