replaceAllowlist

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

With no annotations, the description carries the full burden. It discloses the destructive nature (removes all existing entries) and provides a safety restriction. It does not detail authorization or rate limits, but the key behavioral trait of wholesale replacement is clearly warned.

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 extremely concise with two sentences plus a warning and note. The main action is front-loaded, and every sentence adds value with no extraneous 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?

Given the simple tool with two parameters and no output schema, the description is fairly complete. It explains the operation, warns about destruction, and restricts usage. A minor gap is the lack of mention of profile context, but the profile_id parameter covers that.

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 both parameters are described in the schema. The description adds context that the body replaces the entire allowlist and warns about removal. This supplements the schema but adds no additional parameter-level details beyond the purpose.

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 ('Replaces the entire allowlist') and the resource ('allowlist') with input ('provided list of domains'). It distinguishes from siblings like addToAllowlist and removeFromAllowlist by emphasizing wholesale replacement.

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 safety note restricts usage to 'designated test profiles,' and the warning about removing all existing entries implies appropriate vs. inappropriate contexts. It does not explicitly name alternatives, but the context of sibling tool names provides implicit guidance.

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