nodes_suspend_all

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

The description only states the action, without disclosing behavioral traits such as preconditions (e.g., project must be open), effects on network connections, reversibility, or error handling. Since there are no annotations, the description carries the full burden but falls short.

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 a single sentence, which is concise but under-informative. It lacks details that would justify its brevity, making it less useful than a slightly longer but more complete description.

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 lack of annotations and minimal description, the tool's behavior is underspecified. Important context about the scope of the action (e.g., affects all nodes regardless of state), prerequisites, and potential consequences is missing, despite the presence of an output schema.

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?

With 0% schema description coverage, the description adds no meaning to the single optional parameter 'project_id'. It doesn't explain what the parameter does or when to specify it.

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 ('suspend') and resource ('every node in the project'), effectively distinguishing it from sibling tools like 'node_suspend' (single node) and 'nodes_start_all' (start all).

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?

No guidance on when or when not to use this tool, nor any mention of alternatives. For example, it doesn't say 'Use this to suspend all nodes at once; for individual nodes use node_suspend.'

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