Skip to main content

Documentation Index

Fetch the complete documentation index at: https://openclaw.zhcndoc.com/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 Agents 不同,后者由 OpenClaw 通过 acpx 运行 诸如 Codex 或 Claude Code 之类的外部 harness。 快速规则:
  • 编辑器/客户端想通过 ACP 与 OpenClaw 通信:使用 openclaw acp
  • OpenClaw 应该启动 Codex/Claude/Gemini 作为 ACP harness:使用 /acp spawnACP Agents

兼容性矩阵

ACP 领域状态备注
initialize, newSession, prompt, cancel已实现通过 stdio 到 Gateway chat/send + abort 的核心桥接流程。
listSessions, slash 命令已实现会话列表基于 Gateway 会话状态工作;命令通过 available_commands_update 进行广告。
loadSession部分支持将 ACP 会话重新绑定到一个 Gateway 会话键,并重放已保存的用户/助手文本历史。工具/系统历史尚未重建。
提示内容(text、嵌入的 resource、图片)部分支持文本/资源会被展开为聊天输入;图片会变成 Gateway 附件。
会话模式部分支持支持 session/set_mode,并且桥接暴露了初始的、基于 Gateway 的会话控制项,用于思考级别、工具详细程度、推理、用量细节和提升权限的操作。更广泛的 ACP 原生模式/配置界面仍不在范围内。
会话信息和用量更新部分支持桥接会从缓存的 Gateway 会话快照中发出 session_info_update 和尽力而为的 usage_update 通知。用量是近似值,并且只有在 Gateway 标记 token 总数为新鲜数据时才会发送。
工具流式输出部分支持当 Gateway 工具参数/结果暴露原始 I/O、文本内容以及尽力而为的文件位置时,tool_call / tool_call_update 事件会包含这些信息。嵌入式终端和更丰富的基于 diff 的输出仍未暴露。
每会话 MCP 服务器(mcpServers不支持桥接模式会拒绝每会话 MCP 服务器请求。请在 OpenClaw gateway 或 agent 上配置 MCP。
客户端文件系统方法(fs/read_text_filefs/write_text_file不支持桥接不会调用 ACP 客户端文件系统方法。
客户端终端方法(terminal/*不支持桥接不会创建 ACP 客户端终端,也不会通过工具调用流式传递终端 id。
会话计划 / 思考流式输出不支持当前桥接发出的是输出文本和工具状态,而不是 ACP 计划或思考更新。

已知限制

  • loadSession 会重放已保存的用户和助手文本历史,但不会重建历史工具调用、系统通知或更丰富的 ACP 原生事件类型。
  • 如果多个 ACP 客户端共享同一个 Gateway 会话键,事件和取消路由只能尽力而为,而不能做到严格的按客户端隔离。若你需要干净的编辑器本地轮次,请优先使用默认隔离的 acp:<uuid> 会话。
  • Gateway 停止状态会被转换为 ACP 停止原因,但这种映射不如完整的 ACP 原生运行时表达力强。
  • 当前会话控制仅暴露 Gateway 选项中的一个聚焦子集:思考级别、工具详细程度、推理、用量细节和提升权限操作。模型选择和 exec-host 控制尚未作为 ACP 配置选项暴露出来。
  • session_info_updateusage_update 来源于 Gateway 会话快照,而不是实时的 ACP 原生运行时记账。用量是近似值,不包含成本数据,并且只有在 Gateway 将 token 总数据标记为新鲜时才会发出。
  • 工具跟随数据只能尽力而为。桥接可以暴露出已知工具参数/结果中出现的文件路径,但尚不会发出 ACP 终端或结构化文件 diff。

用法

openclaw acp

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

# 远程 Gateway(从文件获取 token)
openclaw acp --url wss://gateway-host:18789 --token-file ~/.openclaw/gateway.token

# 附加到一个现有会话键
openclaw acp --session agent:main:main

# 按标签附加(必须已存在)
openclaw acp --session-label "support inbox"

# 在第一条提示前重置会话键
openclaw acp --session agent:main:main --reset-session

ACP 客户端(调试)

使用内置的 ACP 客户端在不依赖 IDE 的情况下快速检查桥接是否正常。 它会启动 ACP 桥接,并允许你交互式输入提示。
openclaw acp client

# 将启动的桥接指向远程 Gateway
openclaw acp client --server-args --url wss://gateway-host:18789 --token-file ~/.openclaw/gateway.token

# 覆盖服务器命令(默认:openclaw)
openclaw acp client --server "node" --server-args openclaw.mjs acp --url ws://127.0.0.1:19001
权限模型(客户端调试模式):
  • 自动批准基于白名单,并且只适用于受信任的核心工具 ID。
  • read 的自动批准作用域限定为当前工作目录(设置了 --cwd 时)。
  • ACP 只会自动批准窄范围的只读类别:当前 cwd 下作用域内的 read 调用,以及只读搜索工具(searchweb_searchmemory_search)。未知/非核心工具、超出作用域的读取、具备执行能力的工具、控制平面工具、会修改状态的工具以及交互式流程始终需要显式的提示批准。
  • 服务器提供的 toolCall.kind 会被视为不可信元数据(不是授权来源)。
  • 这个 ACP 桥接策略与 ACPX harness 权限是分开的。如果你通过 acpx 后端运行 OpenClaw,plugins.entries.acpx.config.permissionMode=approve-all 是该 harness 会话的破窗“yolo”开关。

如何使用

当某个 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>
# 本地进程安全时推荐
openclaw acp --url wss://gateway-host:18789 --token-file ~/.openclaw/gateway.token

选择 agent

ACP 不会直接选择 agent。它是按 Gateway 会话键进行路由的。 使用按 agent 作用域划分的会话键来定位特定 agent:
openclaw acp --session agent:main:main
openclaw acp --session agent:design:main
openclaw acp --session agent:qa:bug-123
每个 ACP 会话都会映射到一个单独的 Gateway 会话键。一个 agent 可以拥有多个 会话;ACP 默认使用隔离的 acp:<uuid> 会话,除非你覆盖 该键或标签。 桥接模式不支持每会话 mcpServers。如果 ACP 客户端在 newSessionloadSession 期间发送它们, 桥接会返回清晰的错误,而不是静默忽略。 如果你希望基于 ACPX 的会话看到 OpenClaw 插件工具或某些 内置工具(例如 cron),请启用 gateway 侧的 ACPX MCP 桥接, 而不是尝试传递每会话 mcpServers。请参阅 ACP AgentsOpenClaw tools MCP bridge

acpx 使用(Codex、Claude 及其他 ACP 客户端)

如果你想让像 Codex 或 Claude Code 这样的编码代理通过 ACP 与你的 OpenClaw 机器人通信,请使用带有内置 openclaw 目标的 acpx 典型流程:
  1. 运行 Gateway,并确保 ACP bridge 可以访问它。
  2. acpx openclaw 指向 openclaw acp
  3. 指定你希望编码代理使用的 OpenClaw 会话键。
示例:
# 向默认的 OpenClaw ACP 会话发起一次性请求
acpx openclaw exec "总结当前 OpenClaw 会话状态。"

# 用于后续轮次的持久命名会话
acpx openclaw sessions ensure --name codex-bridge
acpx openclaw -s codex-bridge --cwd /path/to/repo \
  "让我的 OpenClaw 工作代理提供与此仓库相关的最新上下文。"
如果你希望 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"
    }
  }
}
对于仓库本地的 OpenClaw 检出,请直接使用 CLI 入口,而不是 dev runner,这样 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 的设置界面):
{
  "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 中,打开 Agent 面板并选择“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_TOKENOPENCLAW_GATEWAY_PASSWORD)。
  • Gateway 认证解析遵循其他 Gateway 客户端使用的共享约定:
    • 本地模式:env(OPENCLAW_GATEWAY_*)-> gateway.auth.* -> 仅在 gateway.auth.* 未设置时回退到 gateway.remote.*(已配置但未解析的本地 SecretRefs 会关闭失败)
    • 远程模式:gateway.remote.*,并按照远程优先级规则回退到 env/config
    • --url 可安全覆盖,并且不会复用隐式配置/env 凭据;请传入显式的 --token/--password(或文件变体)
  • ACP 运行时后端子进程会接收 OPENCLAW_SHELL=acp,可用于基于上下文的 shell/profile 规则。
  • openclaw acp client 会在启动的 bridge 进程上设置 OPENCLAW_SHELL=acp-client

acp client 选项

  • --cwd <dir>:ACP 会话的工作目录。
  • --server <command>:ACP 服务器命令(默认:openclaw)。
  • --server-args <args...>:传递给 ACP 服务器的额外参数。
  • --server-verbose:在 ACP 服务器上启用详细日志。
  • --verbose, -v:详细的客户端日志。

相关内容