跳轉到主要內容

Documentation Index

Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

執行與 OpenClaw Gateway 通訊的 Agent Client Protocol (ACP) 橋接器。 此命令透過 stdio 對 IDE 使用 ACP，並透過 WebSocket 將提示轉送到 Gateway。它會將 ACP 工作階段對應到 Gateway 工作階段金鑰。 openclaw acp 是由 Gateway 支援的 ACP 橋接器，而不是完整 ACP 原生編輯器執行階段。它聚焦於工作階段路由、提示傳遞，以及基本串流更新。 如果你想讓外部 MCP 用戶端直接與 OpenClaw 頻道對話通訊，而不是託管 ACP harness 工作階段，請改用 openclaw mcp serve。

​
這不是什麼

此頁面常與 ACP harness 工作階段混淆。 openclaw acp 表示：
  • OpenClaw 充當 ACP 伺服器
  • IDE 或 ACP 用戶端連線到 OpenClaw
  • OpenClaw 將該工作轉送到 Gateway 工作階段
這不同於 ACP 代理，後者是 OpenClaw 透過 acpx 執行 Codex 或 Claude Code 等外部 harness。 快速規則：
  • 編輯器/用戶端想用 ACP 與 OpenClaw 通訊：使用 openclaw acp
  • OpenClaw 應以 ACP harness 方式啟動 Codex/Claude/Gemini：使用 /acp spawn 和 ACP 代理

​
相容性矩陣

ACP 區域狀態備註
initialize, newSession, prompt, cancel已實作核心橋接流程透過 stdio 到 Gateway chat/send + abort。
listSessions, slash commands已實作工作階段清單會針對 Gateway 工作階段狀態運作，具備有界游標分頁，且在 Gateway 工作階段列帶有工作區中繼資料時支援 cwd 篩選；命令會透過 available_commands_update 公告。
工作階段譜系中繼資料已實作工作階段列表和工作階段資訊快照會在 _meta 中包含 OpenClaw 父子譜系，讓 ACP 用戶端不需使用私有 Gateway 側通道即可呈現子代理圖。
resumeSession, closeSession已實作Resume 會將 ACP 工作階段重新繫結到既有 Gateway 工作階段，而不重播歷史。Close 會取消作用中的橋接工作、將待處理提示解析為已取消，並釋放橋接工作階段狀態。
loadSession部分支援將 ACP 工作階段重新繫結到 Gateway 工作階段金鑰，並為橋接器建立的工作階段重播 ACP 事件帳本歷史。較舊/無帳本的工作階段會退回使用已儲存的使用者/助理文字。
提示內容（text、嵌入式 resource、圖片）部分支援文字/資源會扁平化為聊天輸入；圖片會成為 Gateway 附件。
工作階段模式部分支援支援 session/set_mode，且橋接器會公開初始 Gateway 支援的工作階段控制，用於思考層級、工具詳細程度、推理、用量細節和提升權限動作。更廣泛的 ACP 原生模式/設定表面仍不在範圍內。
工作階段資訊和用量更新部分支援橋接器會從快取的 Gateway 工作階段快照發出 session_info_update 和盡力而為的 usage_update 通知。用量為近似值，且只會在 Gateway token 總數標示為新鮮時傳送。
工具串流部分支援tool_call / tool_call_update 事件會在 Gateway 工具引數/結果公開時包含原始 I/O、文字內容，以及盡力而為的檔案位置。嵌入式終端機和更豐富的 diff 原生輸出仍未公開。
Exec 核准部分支援作用中的 ACP 提示回合期間，Gateway exec 核准提示會以 session/request_permission 轉送到 ACP 用戶端。
每工作階段 MCP 伺服器（mcpServers）不支援橋接模式會拒絕每工作階段 MCP 伺服器請求。請改在 OpenClaw gateway 或代理上設定 MCP。
用戶端檔案系統方法（fs/read_text_file, fs/write_text_file）不支援橋接器不會呼叫 ACP 用戶端檔案系統方法。
用戶端終端機方法（terminal/*）不支援橋接器不會建立 ACP 用戶端終端機，也不會透過工具呼叫串流終端機 ID。
工作階段計畫 / 思考串流不支援橋接器目前會發出輸出文字和工具狀態，而不是 ACP 計畫或思考更新。

​
已知限制

  • loadSession 只能為橋接器建立的工作階段重播完整 ACP 事件帳本歷史。較舊/無帳本的工作階段仍使用逐字稿退回機制，且不會重建歷史工具呼叫或系統通知。
  • 如果多個 ACP 用戶端共用同一個 Gateway 工作階段金鑰，事件和取消路由會是盡力而為，而不是依用戶端嚴格隔離。需要乾淨的編輯器本機回合時，請偏好預設隔離的 acp:<uuid> 工作階段。
  • Gateway 停止狀態會轉譯為 ACP 停止原因，但該對應不如完整 ACP 原生執行階段具表達力。
  • 初始工作階段控制目前公開一組聚焦的 Gateway 調整項：思考層級、工具詳細程度、推理、用量細節和提升權限動作。模型選擇和 exec-host 控制尚未公開為 ACP 設定選項。
  • session_info_update 和 usage_update 來自 Gateway 工作階段快照，而不是即時 ACP 原生執行階段計量。用量為近似值、不含成本資料，且只會在 Gateway 將 token 總數資料標示為新鮮時發出。
  • 工具跟隨資料是盡力而為。橋接器可以顯示出現在已知工具引數/結果中的檔案路徑，但尚未發出 ACP 終端機或結構化檔案 diff。
  • Exec 核准轉送範圍限於作用中的 ACP 提示回合；來自其他 Gateway 工作階段的核准會被忽略。

​
用法

openclaw acp

# Remote Gateway
openclaw acp --url wss://gateway-host:18789 --token <token>

# Remote Gateway (token from file)
openclaw acp --url wss://gateway-host:18789 --token-file ~/.openclaw/gateway.token

# Attach to an existing session key
openclaw acp --session agent:main:main

# Attach by label (must already exist)
openclaw acp --session-label "support inbox"

# Reset the session key before the first prompt
openclaw acp --session agent:main:main --reset-session

​
ACP 用戶端（偵錯）

使用內建 ACP 用戶端可在沒有 IDE 的情況下對橋接器進行基本檢查。 它會產生 ACP 橋接器，並讓你以互動方式輸入提示。 
openclaw acp client

# Point the spawned bridge at a remote Gateway
openclaw acp client --server-args --url wss://gateway-host:18789 --token-file ~/.openclaw/gateway.token

# Override the server command (default: openclaw)
openclaw acp client --server "node" --server-args openclaw.mjs acp --url ws://127.0.0.1:19001
權限模型（用戶端偵錯模式）：
  • 自動核准以允許清單為基礎，且只適用於受信任的核心工具 ID。
  • read 自動核准的範圍限於目前工作目錄（設定時為 --cwd）。
  • ACP 只會自動核准狹窄的唯讀類別：作用中 cwd 下的範圍化 read 呼叫，以及唯讀搜尋工具（search, web_search, memory_search）。未知/非核心工具、超出範圍的讀取、具 exec 能力的工具、控制平面工具、會變更狀態的工具，以及互動式流程一律需要明確提示核准。
  • 伺服器提供的 toolCall.kind 會視為不受信任的中繼資料（不是授權來源）。
  • 此 ACP 橋接器政策與 ACPX harness 權限不同。如果你透過 acpx 後端執行 OpenClaw，plugins.entries.acpx.config.permissionMode=approve-all 是該 harness 工作階段的緊急「yolo」開關。

​
通訊協定冒煙測試

若要進行通訊協定層級偵錯，請使用隔離狀態啟動 Gateway，並透過 stdio 以 ACP JSON-RPC 用戶端驅動 openclaw acp。涵蓋 initialize、session/new、帶絕對 cwd 的 session/list、session/resume、session/close、重複 close，以及缺少 resume。 證明應包含公告的生命週期能力、Gateway 支援的工作階段列、更新通知，以及 Gateway sessions.list 記錄： 
{
  "initialize": {
    "protocolVersion": 1,
    "agentCapabilities": {
      "sessionCapabilities": {
        "list": {},
        "resume": {},
        "close": {}
      }
    }
  },
  "listSessions": {
    "sessions": [
      {
        "sessionId": "agent:main:acp-smoke",
        "cwd": "/path/to/workspace",
        "_meta": {
          "sessionKey": "agent:main:acp-smoke",
          "kind": "direct"
        }
      }
    ],
    "nextCursor": null
  },
  "notifications": ["session_info_update", "available_commands_update", "usage_update"],
  "gatewayLogTail": ["[gateway] ready", "[ws] ⇄ res ✓ sessions.list 305ms"]
}
避免將 openclaw gateway call sessions.list 作為唯一 ACP 證明。該 CLI 路徑可能會請求 fresh-token 操作者範圍升級；ACP 橋接器正確性是由 ACP stdio frames 加上 Gateway sessions.list 記錄證明。

​
如何使用這個功能

當 IDE（或其他用戶端）使用 Agent Client Protocol，且你希望它驅動 OpenClaw Gateway 工作階段時，請使用 ACP。
  1. 確認 Gateway 正在執行（本機或遠端）。
  2. 設定 Gateway 目標（設定或旗標）。
  3. 將 IDE 指向透過 stdio 執行 openclaw acp。
範例設定（持久化）： 
openclaw config set gateway.remote.url wss://gateway-host:18789
openclaw config set gateway.remote.token <token>
範例直接執行（不寫入設定）： 
openclaw acp --url wss://gateway-host:18789 --token <token>
# preferred for local process safety
openclaw acp --url wss://gateway-host:18789 --token-file ~/.openclaw/gateway.token

​
選擇代理

ACP 不會直接選擇代理。它會依 Gateway 工作階段金鑰進行路由。 使用代理範圍工作階段金鑰來指定特定代理： 
openclaw acp --session agent:main:main
openclaw acp --session agent:design:main
openclaw acp --session agent:qa:bug-123
每個 ACP 工作階段對應到單一 Gateway 工作階段金鑰。一個代理可以有多個 工作階段；除非你覆寫金鑰或標籤，否則 ACP 預設使用隔離的 acp:<uuid> 工作階段。 橋接模式不支援每個工作階段個別設定 mcpServers。如果 ACP 用戶端在 newSession 或 loadSession 期間傳送它們，橋接器會回傳清楚的錯誤， 而不是默默忽略。 如果你想讓 ACPX 後端支援的工作階段看見 OpenClaw Plugin 工具，或所選的 內建工具例如 cron，請改為啟用 Gateway 端的 ACPX MCP 橋接器， 而不是嘗試傳遞每個工作階段的 mcpServers。請參閱 ACP 代理和 OpenClaw 工具 MCP 橋接器。

​
從 acpx 使用（Codex、Claude、其他 ACP 用戶端）

如果你想讓 Codex 或 Claude Code 等程式碼代理透過 ACP 與你的 OpenClaw bot 溝通，請使用 acpx 及其內建的 openclaw 目標。 典型流程：
  1. 執行 Gateway，並確認 ACP 橋接器可以連上它。
  2. 將 acpx openclaw 指向 openclaw acp。
  3. 指定你想讓程式碼代理使用的 OpenClaw 工作階段金鑰。
範例： 
# One-shot request into your default OpenClaw ACP session
acpx openclaw exec "Summarize the active OpenClaw session state."

# Persistent named session for follow-up turns
acpx openclaw sessions ensure --name codex-bridge
acpx openclaw -s codex-bridge --cwd /path/to/repo \
  "Ask my OpenClaw work agent for recent context relevant to this repo."
如果你想讓 acpx openclaw 每次都指向特定的 Gateway 和工作階段金鑰， 請在 ~/.acpx/config.json 中覆寫 openclaw 代理命令： 
{
  "agents": {
    "openclaw": {
      "command": "env OPENCLAW_HIDE_BANNER=1 OPENCLAW_SUPPRESS_NOTES=1 openclaw acp --url ws://127.0.0.1:18789 --token-file ~/.openclaw/gateway.token --session agent:main:main"
    }
  }
}
對於 repo 本機的 OpenClaw checkout，請使用直接的 CLI 進入點， 而不是開發執行器，讓 ACP 串流保持乾淨。例如： 
env OPENCLAW_HIDE_BANNER=1 OPENCLAW_SUPPRESS_NOTES=1 node openclaw.mjs acp ...
這是讓 Codex、Claude Code 或其他支援 ACP 的用戶端從 OpenClaw 代理 擷取情境資訊的最簡單方式，不需要擷取終端機內容。

​
Zed 編輯器設定

在 ~/.config/zed/settings.json 中新增自訂 ACP 代理（或使用 Zed 的設定 UI）： 
{
  "agent_servers": {
    "OpenClaw ACP": {
      "type": "custom",
      "command": "openclaw",
      "args": ["acp"],
      "env": {}
    }
  }
}
若要指定特定 Gateway 或代理： 
{
  "agent_servers": {
    "OpenClaw ACP": {
      "type": "custom",
      "command": "openclaw",
      "args": [
        "acp",
        "--url",
        "wss://gateway-host:18789",
        "--token",
        "<token>",
        "--session",
        "agent:design:main"
      ],
      "env": {}
    }
  }
}
在 Zed 中，開啟代理面板並選取 “OpenClaw ACP” 以開始對話串。

​
工作階段對應

預設情況下，ACP 工作階段會取得帶有 acp: 前綴的隔離 Gateway 工作階段金鑰。 若要重用已知工作階段，請傳入工作階段金鑰或標籤：
  • --session <key>：使用特定 Gateway 工作階段金鑰。
  • --session-label <label>：依標籤解析現有工作階段。
  • --reset-session：為該金鑰產生新的工作階段 ID（相同金鑰，新的逐字稿）。
如果你的 ACP 用戶端支援中繼資料，你可以依工作階段覆寫： 
{
  "_meta": {
    "sessionKey": "agent:main:main",
    "sessionLabel": "support inbox",
    "resetSession": true
  }
}
請在 /concepts/session 進一步了解工作階段金鑰。

​
選項

  • --url <url>：Gateway WebSocket URL（設定時預設為 gateway.remote.url）。
  • --token <token>：Gateway 驗證權杖。
  • --token-file <path>：從檔案讀取 Gateway 驗證權杖。
  • --password <password>：Gateway 驗證密碼。
  • --password-file <path>：從檔案讀取 Gateway 驗證密碼。
  • --session <key>：預設工作階段金鑰。
  • --session-label <label>：要解析的預設工作階段標籤。
  • --require-existing：如果工作階段金鑰/標籤不存在則失敗。
  • --reset-session：在第一次使用前重設工作階段金鑰。
  • --no-prefix-cwd：不要在提示前加上工作目錄前綴。
  • --provenance <off|meta|meta+receipt>：包含 ACP 來源中繼資料或收據。
  • --verbose, -v：將詳細記錄輸出到 stderr。
安全性注意事項：
  • 在某些系統上，--token 和 --password 可能會顯示在本機程序列表中。
  • 建議使用 --token-file/--password-file 或環境變數（OPENCLAW_GATEWAY_TOKEN、OPENCLAW_GATEWAY_PASSWORD）。
  • Gateway 驗證解析會遵循其他 Gateway 用戶端使用的共用合約：
    • 本機模式：env（OPENCLAW_GATEWAY_*）-> gateway.auth.* -> 僅在未設定 gateway.auth.* 時才 fallback 至 gateway.remote.*（已設定但未解析的本機 SecretRefs 會安全失敗）
    • 遠端模式：gateway.remote.* 搭配 env/config fallback，依遠端優先順序規則處理
    • --url 可安全覆寫，且不會重用隱含的 config/env 憑證；請傳入明確的 --token/--password（或檔案變體）
  • ACP 執行階段後端子程序會收到 OPENCLAW_SHELL=acp，可用於特定情境的 shell/profile 規則。
  • openclaw acp client 會在產生的橋接程序上設定 OPENCLAW_SHELL=acp-client。

​
acp client 選項

  • --cwd <dir>：ACP 工作階段的工作目錄。
  • --server <command>：ACP 伺服器命令（預設：openclaw）。
  • --server-args <args...>：傳遞給 ACP 伺服器的額外引數。
  • --server-verbose：在 ACP 伺服器上啟用詳細記錄。
  • --verbose, -v：詳細用戶端記錄。

​
相關