compose_config
Renders the canonical Docker Compose configuration after merges, profiles, and variable substitution. Use it to validate compose files and preview what the CLI will run before compose_up.
Instructions
Render the canonical compose configuration after merges, profiles, and variable substitution.
Use it to validate compose files and see exactly what the CLI will run before compose_up.
Does not raise on a non-zero CLI exit: on a failed render config may be None — inspect
raw.stderr.
args:
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
profiles - Profiles to activate before rendering
services_only - List service names only (--services)
format - "yaml" (default) or "json"
returns: dict - {"config": str|dict|None, "raw": };
config is a parsed dict when format="json" and parsing succeeds,
otherwise the rendered text from stdout.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| files | No | ||
| format | No | yaml | |
| profiles | No | ||
| project_dir | No | ||
| project_name | No | ||
| services_only | No |