Skip to main content
Glama

compose_pause

Pause all or selected containers in a Docker Compose project, freezing processes to halt CPU usage while preserving memory, network endpoints, and state until you resume them.

Instructions

Pause the containers of a compose project (freezes their processes in place).

Paused containers stop consuming CPU but keep memory, network endpoints, and state; resume with compose_unpause. To actually stop containers (each one's configured stop signal, freeing resources) use compose_stop; to stop and delete them use compose_down. Does not raise on a non-zero CLI exit (a missing compose plugin or a timeout still raises) - inspect returncode/stderr in the result.

Args: services: Restrict to these services (default: all) project_dir: Dir with the compose file (default: server cwd; copied to the target host if no local plugin) files: Explicit compose file paths (repeatable, -f) project_name: Compose project name override

Returns: dict: {"returncode": int, "stdout": str, "stderr": str, "truncated": bool}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filesNo
servicesNo
project_dirNo
project_nameNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.9.0

TDQS

A5/5.0
Behavior5/5

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

With only readOnlyHint and destructiveHint annotations (both false), the description carries the burden of behavioral details and does so well. It explains the meaning of pause (CPU stops, memory/network/state retained), and precisely discloses error-handling behavior: non-zero CLI exits do not raise, but a missing plugin or timeout does.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Each section is purposeful: a crisp purpose sentence, a short contrast-and-consequences paragraph, a compact Args list, and a Returns line. The structure is front-loaded with the most important decision (pause vs stop vs down) and the content respects the agent's time.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description covers the tool's behavior, alternatives, error handling, all parameters, and the return dict shape. There is no output schema, so the explicit `Returns: dict...` line is genuinely necessary and sufficient. For a tool of this complexity, an agent has everything needed to call it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must fully compensate. The Args section provides meaningful context for every parameter: `services` restricts targets, `project_dir` identifies the compose file location and even notes the copy-to-host nuance, `files` supports repeatable `-f` usage, and `project_name` overrides the project name.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb+resource combination ('Pause the containers of a compose project') and immediately clarifies the semantics with 'freezes their processes in place.' It also names the relevant siblings (`compose_unpause`, `compose_stop`, `compose_down`), making it easy to distinguish from nearby tools like `container_pause`.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explains exactly when to use this tool: when you want to freeze containers without releasing resources. It explicitly contrasts it with `compose_stop` (stop and free resources) and `compose_down` (stop and delete), and points to `compose_unpause` for resuming, giving clear if-then guidance.

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

Deploy Server

Other Tools