controller_shutdown

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

No annotations exist, so description must fully disclose behavior. The description only labels as 'Destructive' but lacks details on side effects (e.g., ongoing operations, irreversibility, system state changes).

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?

Extremely concise with two sentences. Action verb first, followed by key requirements and nature. No wasted 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?

For a tool with output schema, description covers core action and constraint but omits consequences of shutdown (e.g., project inaccessibility, need for restart). Adequate but not fully comprehensive given destructive nature.

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 0%, but description crucially clarifies that confirm must be true for shutdown to execute. This adds essential semantic meaning beyond the schema's default false and type.

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 'Shut down the GNS3 controller process', specifying the exact action and resource. It distinguishes from sibling 'controller_reload' which implies restart rather than stop.

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?

States 'Requires confirm=true', a key usage requirement. However, no guidance on when to use this tool versus alternatives like controller_reload or other shutdown methods.

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