bricks_switch_site

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

Discloses side effects: 'Clears cache and warms the new site.' With no annotations, this adds value. However, does not mention potential reversibility, required permissions, or whether the operation is safe to repeat.

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 concise sentences: first states the action, second lists side effects and a helpful reference. No wasted words, front-loaded with core purpose.

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?

Adequate for a simple one-parameter tool with no output schema. Covers purpose, side effects, and parameter source. Minor omission: no mention of return value or success/failure indication.

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?

The sole parameter 'key' is documented in schema with examples. The description adds context by directing users to bricks_list_sites for valid keys, adding value beyond schema alone.

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 'Switch the active WordPress site' with a specific verb and resource. It distinguishes from siblings like bricks_active_site (get current) and bricks_list_sites (list available sites).

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?

Explicitly instructs to use bricks_list_sites to see available keys, providing clear prerequisite guidance. Does not specify when not to use or alternative tools, but context is sufficient for this singular switch action.

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