Suspend service

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

Goes well beyond the destructiveHint annotation by disclosing the state transition, the required auth scopes (services:manage, full-access API key), the running precondition, and the tracking event ID return value. These are exactly the operational facts an agent needs before invoking a mutation.

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?

Four short sentences with the action and resulting state front-loaded, followed by return value and constraints. No filler; every sentence carries necessary 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?

With no output schema, the description helpfully names the return value (tracking event ID). Combined with auth requirements, platform restriction, and precondition, an agent has everything needed to call this tool correctly.

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 description coverage is 100% and the single orderNo parameter is fully documented in the schema (format, pattern, example). The description adds no parameter-level detail beyond this, so the baseline of 3 applies.

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?

States a specific verb (Suspend) and resource (running Cloud VPS/KVM/VDS service) and clarifies the resulting state change to 'suspended', which distinguishes it from stop_service and resume_service. Scope is narrowed to VDS/Cloud VPS, so an agent can tell what kind of service it applies to.

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 clear preconditions: VDS/Cloud VPS only and the service must be running. It does not explicitly name alternatives (e.g., resume_service or stop_service) or say when suspension is preferable, so it stops short of full when/when-not guidance.

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