compose_pause

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

The description discloses key behavioral details beyond the sparse annotations: CPU/memory/network/state effects, reversibility, and the fact that non-zero CLI exits do not raise but are reported via returncode/stderr. This is substantial value beyond readOnlyHint and destructiveHint.

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 front-loaded with a clear, specific first sentence, followed by a compact explanatory paragraph and structured parameter list. Every sentence adds value without redundancy or filler.

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 absence of an output schema, the description still covers the return value shape, parameter semantics, usage context, and behavioral caveats. It is complete enough for an agent to select and invoke the 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?

Despite 0% schema description coverage, the description explains every parameter: services restriction/default, project_dir default and copy behavior, files repeatable with -f, and project_name override. This fully compensates for the structured schema's lack of descriptions.

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: 'Pause the containers of a compose project (freezes their processes in place).' It also distinguishes from related tools like compose_stop and compose_down by naming them explicitly.

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?

It provides explicit when-to-use guidance: 'Paused containers stop consuming CPU but keep memory, network endpoints, and state; resume with compose_unpause.' It also contrasts with compose_stop and compose_down, and explains the non-raising CLI exit behavior.

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