Skip to main content

ACP agents

Agent Client Protocol (ACP) sessions let OpenClaw run external coding harnesses (for example Pi, Claude Code, Codex, OpenCode, and Gemini CLI) through an ACP backend plugin. If you ask OpenClaw in plain language to “run this in Codex” or “start Claude Code in a thread”, OpenClaw should route that request to the ACP runtime (not the native sub-agent runtime).

Fast operator flow

Use this when you want a practical /acp runbook:
  1. Spawn a session:
    • /acp spawn codex --mode persistent --thread auto
  2. Work in the bound thread (or target that session key explicitly).
  3. Check runtime state:
    • /acp status
  4. Tune runtime options as needed:
    • /acp model <provider/model>
    • /acp permissions <profile>
    • /acp timeout <seconds>
  5. Nudge an active session without replacing context:
    • /acp steer tighten logging and continue
  6. Stop work:
    • /acp cancel (stop current turn), or
    • /acp close (close session + remove bindings)

Quick start for humans

Examples of natural requests:
  • “Start a persistent Codex session in a thread here and keep it focused.”
  • “Run this as a one-shot Claude Code ACP session and summarize the result.”
  • “Use Gemini CLI for this task in a thread, then keep follow-ups in that same thread.”
What OpenClaw should do:
  1. Pick runtime: "acp".
  2. Resolve the requested harness target (agentId, for example codex).
  3. If thread binding is requested and the current channel supports it, bind the ACP session to the thread.
  4. Route follow-up thread messages to that same ACP session until unfocused/closed/expired.

ACP versus sub-agents

Use ACP when you want an external harness runtime. Use sub-agents when you want OpenClaw-native delegated runs.
AreaACP sessionSub-agent run
RuntimeACP backend plugin (for example acpx)OpenClaw native sub-agent runtime
Session keyagent:<agentId>:acp:<uuid>agent:<agentId>:subagent:<uuid>
Main commands/acp .../subagents ...
Spawn toolsessions_spawn with runtime:"acp"sessions_spawn (default runtime)
See also Sub-agents.

Thread-bound sessions (channel-agnostic)

When thread bindings are enabled for a channel adapter, ACP sessions can be bound to threads:
  • OpenClaw binds a thread to a target ACP session.
  • Follow-up messages in that thread route to the bound ACP session.
  • ACP output is delivered back to the same thread.
  • Unfocus/close/archive/idle-timeout or max-age expiry removes the binding.
Thread binding support is adapter-specific. If the active channel adapter does not support thread bindings, OpenClaw returns a clear unsupported/unavailable message. Required feature flags for thread-bound ACP:
  • acp.enabled=true
  • acp.dispatch.enabled=true
  • Channel-adapter ACP thread-spawn flag enabled (adapter-specific)
    • Discord: channels.discord.threadBindings.spawnAcpSessions=true

Thread supporting channels

  • Any channel adapter that exposes session/thread binding capability.
  • Current built-in support: Discord.
  • Plugin channels can add support through the same binding interface.

Start ACP sessions (interfaces)

From sessions_spawn

Use runtime: "acp" to start an ACP session from an agent turn or tool call.
{
  "task": "Open the repo and summarize failing tests",
  "runtime": "acp",
  "agentId": "codex",
  "thread": true,
  "mode": "session"
}
Notes:
  • runtime defaults to subagent, so set runtime: "acp" explicitly for ACP sessions.
  • If agentId is omitted, OpenClaw uses acp.defaultAgent when configured.
  • mode: "session" requires thread: true to keep a persistent bound conversation.
Interface details:
  • task (required): initial prompt sent to the ACP session.
  • runtime (required for ACP): must be "acp".
  • agentId (optional): ACP target harness id. Falls back to acp.defaultAgent if set.
  • thread (optional, default false): request thread binding flow where supported.
  • mode (optional): run (one-shot) or session (persistent).
    • default is run
    • if thread: true and mode omitted, OpenClaw may default to persistent behavior per runtime path
    • mode: "session" requires thread: true
  • cwd (optional): requested runtime working directory (validated by backend/runtime policy).
  • label (optional): operator-facing label used in session/banner text.

From /acp command

Use /acp spawn for explicit operator control from chat when needed.
/acp spawn codex --mode persistent --thread auto
/acp spawn codex --mode oneshot --thread off
/acp spawn codex --thread here
Key flags:
  • --mode persistent|oneshot
  • --thread auto|here|off
  • --cwd <absolute-path>
  • --label <name>
See Slash Commands.

Session target resolution

Most /acp actions accept an optional session target (session-key, session-id, or session-label). Resolution order:
  1. Explicit target argument (or --session for /acp steer)
    • tries key
    • then UUID-shaped session id
    • then label
  2. Current thread binding (if this conversation/thread is bound to an ACP session)
  3. Current requester session fallback
If no target resolves, OpenClaw returns a clear error (Unable to resolve session target: ...).

Spawn thread modes

/acp spawn supports --thread auto|here|off.
ModeBehavior
autoIn an active thread: bind that thread. Outside a thread: create/bind a child thread when supported.
hereRequire current active thread; fail if not in one.
offNo binding. Session starts unbound.
Notes:
  • On non-thread binding surfaces, default behavior is effectively off.
  • Thread-bound spawn requires channel policy support (for Discord: channels.discord.threadBindings.spawnAcpSessions=true).

ACP controls

Available command family:
  • /acp spawn
  • /acp cancel
  • /acp steer
  • /acp close
  • /acp status
  • /acp set-mode
  • /acp set
  • /acp cwd
  • /acp permissions
  • /acp timeout
  • /acp model
  • /acp reset-options
  • /acp sessions
  • /acp doctor
  • /acp install
/acp status shows the effective runtime options and, when available, both runtime-level and backend-level session identifiers. Some controls depend on backend capabilities. If a backend does not support a control, OpenClaw returns a clear unsupported-control error.

ACP command cookbook

CommandWhat it doesExample
/acp spawnCreate ACP session; optional thread bind./acp spawn codex --mode persistent --thread auto --cwd /repo
/acp cancelCancel in-flight turn for target session./acp cancel agent:codex:acp:<uuid>
/acp steerSend steer instruction to running session./acp steer --session support inbox prioritize failing tests
/acp closeClose session and unbind thread targets./acp close
/acp statusShow backend, mode, state, runtime options, capabilities./acp status
/acp set-modeSet runtime mode for target session./acp set-mode plan
/acp setGeneric runtime config option write./acp set model openai/gpt-5.2
/acp cwdSet runtime working directory override./acp cwd /Users/user/Projects/repo
/acp permissionsSet approval policy profile./acp permissions strict
/acp timeoutSet runtime timeout (seconds)./acp timeout 120
/acp modelSet runtime model override./acp model anthropic/claude-opus-4-5
/acp reset-optionsRemove session runtime option overrides./acp reset-options
/acp sessionsList recent ACP sessions from store./acp sessions
/acp doctorBackend health, capabilities, actionable fixes./acp doctor
/acp installPrint deterministic install and enable steps./acp install

Runtime options mapping

/acp has convenience commands and a generic setter. Equivalent operations:
  • /acp model <id> maps to runtime config key model.
  • /acp permissions <profile> maps to runtime config key approval_policy.
  • /acp timeout <seconds> maps to runtime config key timeout.
  • /acp cwd <path> updates runtime cwd override directly.
  • /acp set <key> <value> is the generic path.
    • Special case: key=cwd uses the cwd override path.
  • /acp reset-options clears all runtime overrides for target session.

acpx harness support (current)

Current acpx built-in harness aliases:
  • pi
  • claude
  • codex
  • opencode
  • gemini
When OpenClaw uses the acpx backend, prefer these values for agentId unless your acpx config defines custom agent aliases. Direct acpx CLI usage can also target arbitrary adapters via --agent <command>, but that raw escape hatch is an acpx CLI feature (not the normal OpenClaw agentId path).

Required config

Core ACP baseline:
{
  acp: {
    enabled: true,
    dispatch: { enabled: true },
    backend: "acpx",
    defaultAgent: "codex",
    allowedAgents: ["pi", "claude", "codex", "opencode", "gemini"],
    maxConcurrentSessions: 8,
    stream: {
      coalesceIdleMs: 300,
      maxChunkChars: 1200,
    },
    runtime: {
      ttlMinutes: 120,
    },
  },
}
Thread binding config is channel-adapter specific. Example for Discord:
{
  session: {
    threadBindings: {
      enabled: true,
      idleHours: 24,
      maxAgeHours: 0,
    },
  },
  channels: {
    discord: {
      threadBindings: {
        enabled: true,
        spawnAcpSessions: true,
      },
    },
  },
}
If thread-bound ACP spawn does not work, verify the adapter feature flag first:
  • Discord: channels.discord.threadBindings.spawnAcpSessions=true
See Configuration Reference.

Plugin setup for acpx backend

Install and enable plugin:
openclaw plugins install @openclaw/acpx
openclaw config set plugins.entries.acpx.enabled true
Local workspace install during development:
openclaw plugins install ./extensions/acpx
Then verify backend health:
/acp doctor

Pinned acpx install strategy (current behavior)

@openclaw/acpx now enforces a strict plugin-local pinning model:
  1. The extension pins an exact acpx dependency in extensions/acpx/package.json.
  2. Runtime command is fixed to the plugin-local binary (extensions/acpx/node_modules/.bin/acpx), not global PATH.
  3. Plugin config does not expose command or commandArgs, so runtime command drift is blocked.
  4. Startup registers the ACP backend immediately as not-ready.
  5. A background ensure job verifies acpx --version against the pinned version.
  6. If missing/mismatched, it runs plugin-local install (npm install --omit=dev --no-save acpx@<pinned>) and re-verifies before healthy.
Notes:
  • OpenClaw startup stays non-blocking while acpx ensure runs.
  • If network/install fails, backend remains unavailable and /acp doctor reports an actionable fix.
See Plugins.

Troubleshooting

SymptomLikely causeFix
ACP runtime backend is not configuredBackend plugin missing or disabled.Install and enable backend plugin, then run /acp doctor.
ACP is disabled by policy (acp.enabled=false)ACP globally disabled.Set acp.enabled=true.
ACP dispatch is disabled by policy (acp.dispatch.enabled=false)Dispatch from normal thread messages disabled.Set acp.dispatch.enabled=true.
ACP agent "<id>" is not allowed by policyAgent not in allowlist.Use allowed agentId or update acp.allowedAgents.
Unable to resolve session target: ...Bad key/id/label token.Run /acp sessions, copy exact key/label, retry.
--thread here requires running /acp spawn inside an active ... thread--thread here used outside a thread context.Move to target thread or use --thread auto/off.
Only <user-id> can rebind this thread.Another user owns thread binding.Rebind as owner or use a different thread.
Thread bindings are unavailable for <channel>.Adapter lacks thread binding capability.Use --thread off or move to supported adapter/channel.
Missing ACP metadata for bound sessionStale/deleted ACP session metadata.Recreate with /acp spawn, then rebind/focus thread.