Skip to main content
Glama

Compose: list services

compose_ps

List services defined by a Docker Compose stack and view their current state and health status.

Instructions

List the services defined by a Compose stack and their current state/health. Point file at the compose file or its directory.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fileYesPath to a compose file, or a directory containing one (compose.yaml / docker-compose.yml). Relative paths resolve against the server's configured Compose working directory.
projectNoExplicit Compose project name (defaults to the folder name).
Behavior4/5

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

No annotations are provided, so the description carries the full burden. It clearly indicates a read-only operation (listing state/health) without any destructive hints. While adequate, it could add more context such as that no modifications are made.

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?

The description is two sentences, front-loaded with the purpose, and contains no redundant information. Every word is meaningful.

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

Completeness4/5

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

Given the simple nature of the tool (list services) and full schema coverage, the description is mostly complete. It explains what the tool does and how to specify the file. However, with no output schema, a brief note on the output format would make it more complete.

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

Parameters3/5

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

Schema description coverage is 100%, so baseline is 3. The description adds 'Point `file` at the compose file or its directory', which largely repeats the schema's description. It does not add significant new meaning beyond the schema.

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 uses a specific verb 'List' and clearly identifies the resource 'services defined by a Compose stack and their current state/health'. This distinguishes it from sibling tools like compose_config (configuration) or compose_down (stopping).

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

Usage Guidelines3/5

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

The description implies usage by stating 'Point `file` at the compose file or its directory', giving context on how to use the file parameter. However, it does not explicitly state when to use this tool versus alternatives, nor does it exclude any conditions.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/soyrageagency/docker-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server