pause_resource

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

With no annotations, description fully discloses behavioral traits: no data loss, stops new connections, revokes credential, preserves storage and URL. Also covers error conditions (409 for already paused, 402 for insufficient tier, 404 for invalid token) and authentication requirements (INSTANODE_TOKEN, Pro tier).

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?

Description is efficiently structured with the primary action first, followed by key details and use cases. No redundant sentences, though the authentication note could be placed earlier.

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?

While comprehensive, the description omits whether existing connections are terminated gracefully or left hanging. It also doesn't discuss return value or success indicators. Without an output schema, these details would help.

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 baseline is 3. Description adds value by explaining that the 'id' parameter is a resource token from a create_* call, which aids in understanding where to obtain the value.

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?

Description clearly states the action ('Suspend'), the object ('resource'), and explicitly distinguishes it from deletion. It specifies that storage and URL are preserved, making the purpose unambiguous.

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 concrete use cases (parking database, freezing during incident, temporary access cut) and directs to resume_resource for undoing. While it doesn't explicitly state when not to use, the context and sibling comparison (delete_resource) imply the appropriate scenarios.

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