docker-mcp: Instructions file for Codex

AGENTS.md: LLM Agent Guide for docker-mcp

This guide explains the tool schemas, action discriminators, and best practices for AI agents invoking docker-mcp.

---

1. Tool Reference & Action Discriminators

1. docker_containers

• Schema:
  • action: 'list' | 'inspect' | 'start' | 'stop' | 'restart' | 'logs' | 'stats' | 'exec' | 'remove'
  • id: Container ID or exact name (required for inspect, start, stop, restart, logs, stats, exec, remove)
  • pattern: Regex or substring to filter container names/images on list
  • all: Include non-running (exited/paused) containers on list (default true)
  • tail: Number of lines of logs to retrieve on logs (default 100)
  • timestamps: Include RFC3339 timestamps on logs (default true)
  • command: Array of command strings to execute on exec (e.g. ["ls", "-la", "/app"])
  • force: Force removal or stop (default false)

2. docker_compose

• Schema:
  • action: 'ps' | 'up' | 'down' | 'restart' | 'logs'
  • project: Compose project name (derived from com.docker.compose.project label)
  • services: Array of specific service names to target
  • tail: Number of lines for aggregated logs

3. docker_images

• Schema:
  • action: 'list' | 'inspect' | 'pull' | 'prune' | 'remove'
  • image: Image tag or digest (e.g. node:22-alpine or sha256:...)
  • all: Include intermediate image layers on list (default false)
  • force: Force removal (default false)

4. docker_volumes

• Schema:
  • action: 'list' | 'inspect' | 'create' | 'prune' | 'remove'
  • name: Volume name
  • driver: Storage driver (e.g. local)
  • labels: Key-value label pairs
  • force: Force remove volume

5. docker_networks

• Schema:
  • action: 'list' | 'inspect' | 'create' | 'prune' | 'remove'
  • name: Network name or ID
  • driver: Network driver (bridge, overlay, macvlan)
  • internal: Restrict external network gateway access (default false)