工具(OpenClaw)

OpenClaw 公开一等代理工具用于浏览器、画布、节点和 cron。 这些取代了旧的 openclaw-* 技能:工具是类型化的,不使用 shell,代理应该直接依赖它们。

禁用工具

您可以通过 openclaw.json 中的 tools.allow / tools.deny 全局允许/拒绝工具(deny 优先)。这会阻止不允许的工具被发送到模型提供商。

{
  tools: { deny: ["browser"] },
}

注意:

  • 匹配不区分大小写。
  • 支持通配符 *"*" 表示所有工具)。
  • 如果 tools.allow 仅引用未知或未加载的插件工具名称,OpenClaw 会记录警告并忽略允许列表,以保持核心工具可用。

工具配置文件(基础允许列表)

tools.profiletools.allow/tools.deny 之前设置基础工具允许列表。 每代理覆盖:agents.list[].tools.profile

配置文件:

  • minimal:仅 session_status
  • codinggroup:fsgroup:runtimegroup:sessionsgroup:memoryimage
  • messaginggroup:messagingsessions_listsessions_historysessions_sendsession_status
  • full:无限制(与未设置相同)

示例(默认仅消息,也允许 Slack + Discord 工具):

{
  tools: {
    profile: "messaging",
    allow: ["slack", "discord"],
  },
}

示例(coding 配置文件,但在所有地方拒绝 exec/process):

{
  tools: {
    profile: "coding",
    deny: ["group:runtime"],
  },
}

示例(全局 coding 配置文件,仅消息支持代理):

{
  tools: { profile: "coding" },
  agents: {
    list: [
      {
        id: "support",
        tools: { profile: "messaging", allow: ["slack"] },
      },
    ],
  },
}

提供商特定工具策略

使用 tools.byProvider 进一步限制特定提供商(或单个 provider/model)的工具,而无需更改全局默认值。 每代理覆盖:agents.list[].tools.byProvider

这在基础工具配置文件之后、allow/deny 列表之前应用,因此它只能缩小工具集。 提供商密钥接受 provider(例如 google-antigravity)或 provider/model(例如 openai/gpt-5.2)。

示例(保持全局 coding 配置文件,但 Google Antigravity 使用最小工具):

{
  tools: {
    profile: "coding",
    byProvider: {
      "google-antigravity": { profile: "minimal" },
    },
  },
}

示例(针对不稳定端点的 provider/model 特定允许列表):

{
  tools: {
    allow: ["group:fs", "group:runtime", "sessions_list"],
    byProvider: {
      "openai/gpt-5.2": { allow: ["group:fs", "sessions_list"] },
    },
  },
}

示例(单个提供商的代理特定覆盖):

{
  agents: {
    list: [
      {
        id: "support",
        tools: {
          byProvider: {
            "google-antigravity": { allow: ["message", "sessions_list"] },
          },
        },
      },
    ],
  },
}

工具组(简写)

工具策略(全局、代理、沙盒)支持扩展为多个工具的 group:* 条目。 在 tools.allow / tools.deny 中使用这些。

可用组:

  • group:runtimeexecbashprocess
  • group:fsreadwriteeditapply_patch
  • group:sessionssessions_listsessions_historysessions_sendsessions_spawnsession_status
  • group:memorymemory_searchmemory_get
  • group:webweb_searchweb_fetch
  • group:uibrowsercanvas
  • group:automationcrongateway
  • group:messagingmessage
  • group:nodesnodes
  • group:openclaw:所有内置 OpenClaw 工具(不包括提供商插件)

示例(仅允许文件工具 + 浏览器):

{
  tools: {
    allow: ["group:fs", "browser"],
  },
}

插件 + 工具

插件可以注册额外工具(和 CLI 命令)超越核心集。 有关安装 + 配置,请参阅 插件,有关工具使用指导如何注入提示,请参阅 技能。一些插件随工具一起提供自己的技能(例如,语音通话插件)。

可选插件工具:

  • Lobster:具有可恢复审批的工作流运行时类型(需要在网关主机上安装 Lobster CLI)。
  • LLM Task:仅 JSON 的 LLM 步骤,用于结构化工作流输出(可选模式验证)。

工具清单

apply_patch

在一个或多个文件中应用结构化补丁。用于多 hunk 编辑。 实验性:通过 tools.exec.applyPatch.enabled 启用(仅 OpenAI 模型)。 tools.exec.applyPatch.workspaceOnly 默认为 true(工作区包含)。仅在您有意让 apply_patch 在工作区目录之外写入/删除时才将其设置为 false

exec

在工作区中运行 shell 命令。

核心参数:

  • command(必需)
  • yieldMs(超时后自动后台运行,默认 10000)
  • background(立即后台运行)
  • timeout(秒;超出则终止进程,默认 1800)
  • elevated(布尔值;如果启用/允许提升模式则在主机上运行;仅在代理被沙盒化时改变行为)
  • hostsandbox | gateway | node
  • securitydeny | allowlist | full
  • askoff | on-miss | always
  • node(用于 host=node 的节点 id/名称)
  • 需要真正的 TTY?设置 pty: true

注意:

  • 后台运行时返回 status: "running"sessionId
  • 使用 process 来轮询/日志/写入/终止/清除后台会话。
  • 如果 process 不被允许,exec 同步运行并忽略 yieldMs/background
  • elevatedtools.elevated 加上任何 agents.list[].tools.elevated 覆盖门控(两者都必须允许),并且是 host=gateway + security=full 的别名。
  • elevated 仅在代理被沙盒化时改变行为(否则是空操作)。
  • host=node 可以定位 macOS 伴侣应用或无头节点主机(openclaw node run)。
  • 网关/节点审批和允许列表:Exec 审批

process

管理后台 exec 会话。

核心操作:

  • listpolllogwritekillclearremove

注意:

  • poll 在完成时返回新输出和退出状态。
  • log 支持基于行的 offset/limit(省略 offset 以获取最后 N 行)。
  • process 按代理范围;其他代理的会话不可见。

loop-detection(工具调用循环护栏)

OpenClaw 跟踪最近的工具调用历史,并在检测到重复无进展循环时阻止或警告。 通过 tools.loopDetection.enabled: true 启用(默认 false)。

{
  tools: {
    loopDetection: {
      enabled: true,
      warningThreshold: 10,
      criticalThreshold: 20,
      globalCircuitBreakerThreshold: 30,
      historySize: 30,
      detectors: {
        genericRepeat: true,
        knownPollNoProgress: true,
        pingPong: true,
      },
    },
  },
}
  • genericRepeat:重复相同工具 + 相同参数调用模式。
  • knownPollNoProgress:使用相同输出重复类似轮询的工具。
  • pingPong:交替 A/B/A/B 无进展模式。
  • 每代理覆盖:agents.list[].tools.loopDetection

使用 Brave Search API 搜索网络。

核心参数:

  • query(必需)
  • count(1-10;来自 tools.web.search.maxResults 的默认值)

注意:

  • 需要 Brave API 密钥(推荐:openclaw configure --section web,或设置 BRAVE_API_KEY)。
  • 通过 tools.web.search.enabled 启用。
  • 响应被缓存(默认 15 分钟)。
  • 有关设置,请参阅 Web 工具

web_fetch

从 URL 获取并提取可读内容(HTML → markdown/text)。

核心参数:

  • url(必需)
  • extractModemarkdown | text
  • maxChars(截断长页面)

注意:

  • 通过 tools.web.fetch.enabled 启用。
  • maxCharstools.web.fetch.maxCharsCap 限制(默认 50000)。
  • 响应被缓存(默认 15 分钟)。
  • 对于 JS 密集型网站,首选浏览器工具。
  • 有关设置,请参阅 Web 工具
  • 有关可选的反机器人后备,请参阅 Firecrawl

browser

控制专用 OpenClaw 管理的浏览器。

核心操作:

  • statusstartstoptabsopenfocusclose
  • snapshot(aria/ai)
  • screenshot(返回图像块 + MEDIA:<path>
  • act(UI 操作:click/type/press/hover/drag/select/fill/resize/wait/evaluate)
  • navigateconsolepdfuploaddialog

配置文件管理:

  • profiles — 列出所有浏览器配置文件及状态
  • create-profile — 创建新配置文件,自动分配端口(或 cdpUrl
  • delete-profile — 停止浏览器,删除用户数据,从配置中移除(仅本地)
  • reset-profile — 终止配置文件中孤儿进程(仅本地)

常用参数:

  • profile(可选;默认为 browser.defaultProfile
  • targetsandbox | host | node
  • node(可选;选择特定节点 id/名称)

注意:

  • 需要 browser.enabled=true(默认 true;设置为 false 禁用)。
  • 所有操作接受可选的 profile 参数以支持多实例。
  • 省略 profile 时,使用 browser.defaultProfile(默认为 “chrome”)。
  • 配置文件名称:仅小写字母数字 + 连字符(最多 64 个字符)。
  • 端口范围:18800-18899(最多约 100 个配置文件)。
  • 远程配置文件仅支持附加(无 start/stop/reset)。
  • 如果连接了支持浏览器的节点,工具可能会自动路由到它(除非您固定 target)。
  • 安装 Playwright 时,snapshot 默认为 ai;无障碍树使用 aria
  • snapshot 还支持角色快照选项(interactivecompactdepthselector),返回如 e12 的引用。
  • act 需要来自 snapshotref(AI 快照的数字 12,或角色快照的 e12);罕见 CSS 选择器需求使用 evaluate
  • 默认避免 actwait;仅在例外情况下使用(没有可靠的 UI 状态可等待)。
  • upload 可以选择传递 ref 以在武装后自动点击。
  • upload 还支持 inputRef(aria ref)或 element(CSS 选择器)直接设置 <input type="file">

canvas

驱动节点 Canvas(present、eval、snapshot、A2UI)。

核心操作:

  • presenthidenavigateeval
  • snapshot(返回图像块 + MEDIA:<path>
  • a2ui_pusha2ui_reset

注意:

  • 底层使用网关 node.invoke
  • 如果未提供 node,工具选择默认值(单个连接节点或本地 mac 节点)。
  • A2UI 仅 v0.8(无 createSurface);CLI 拒绝 v0.9 JSONL 并显示行错误。
  • 快速测试:openclaw nodes canvas a2ui push --node <id> --text "Hello from A2UI"

nodes

发现并定位配对节点;发送通知;捕获摄像头/屏幕。

核心操作:

  • statusdescribe
  • pendingapprovereject(配对)
  • notify(macOS system.notify
  • run(macOS system.run
  • camera_snapcamera_clipscreen_record
  • location_get

注意:

  • 摄像头/屏幕命令需要节点应用处于前台。
  • 图像返回图像块 + MEDIA:<path>
  • 视频返回 FILE:<path>(mp4)。
  • 位置返回 JSON 有效负载(lat/lon/accuracy/timestamp)。
  • run 参数:command argv 数组;可选 cwdenvKEY=VAL)、commandTimeoutMsinvokeTimeoutMsneedsScreenRecording

示例(run):

{
  "action": "run",
  "node": "office-mac",
  "command": ["echo", "Hello"],
  "env": ["FOO=bar"],
  "commandTimeoutMs": 12000,
  "invokeTimeoutMs": 45000,
  "needsScreenRecording": false
}

image

使用配置的图像模型分析图像。

核心参数:

  • image(必需,路径或 URL)
  • prompt(可选;默认为 “Describe the image.”)
  • model(可选覆盖)
  • maxBytesMb(可选大小上限)

注意:

  • 仅在配置了 agents.defaults.imageModel(主要或后备)时可用,或当可以从默认模型 + 配置的身份验证推断隐式图像模型时(最佳努力配对)。
  • 直接使用图像模型(独立于主聊天模型)。

message

跨 Discord/Google Chat/Slack/Telegram/WhatsApp/Signal/iMessage/MS Teams 发送消息和频道操作。

核心操作:

  • send(文本 + 可选媒体;MS Teams 还支持 card 用于 Adaptive Cards)
  • poll(WhatsApp/Discord/MS Teams 投票)
  • react / reactions / read / edit / delete
  • pin / unpin / list-pins
  • permissions
  • thread-create / thread-list / thread-reply
  • search
  • sticker
  • member-info / role-info
  • emoji-list / emoji-upload / sticker-upload
  • role-add / role-remove
  • channel-info / channel-list
  • voice-status
  • event-list / event-create
  • timeout / kick / ban

注意:

  • send 通过网关路由 WhatsApp;其他频道直接发送。
  • poll 通过网关使用 WhatsApp 和 MS Teams;Discord 投票直接发送。
  • 当消息工具调用绑定到活动聊天会话时,发送受限限于该会话的目标,以避免跨上下文泄漏。

cron

管理网关 cron 任务和唤醒。

核心操作:

  • statuslist
  • addupdateremoverunruns
  • wake(排队系统事件 + 可选即时心跳)

注意:

  • add 期望完整的 cron 任务对象(与 cron.add RPC 相同模式)。
  • update 使用 { jobId, patch }(接受 id 以保持兼容性)。

gateway

重启或应用更新到正在运行的网关进程(原地)。

核心操作:

  • restart(授权 + 发送 SIGUSR1 进行进程内重启;openclaw gateway 原地重启)
  • config.get / config.schema
  • config.apply(验证 + 写入配置 + 重启 + 唤醒)
  • config.patch(合并部分更新 + 重启 + 唤醒)
  • update.run(运行更新 + 重启 + 唤醒)

注意:

  • 使用 delayMs(默认 2000)避免中断进行中的回复。
  • restart 默认启用;设置 commands.restart: false 禁用。

sessions_list / sessions_history / sessions_send / sessions_spawn / session_status

列出会话、检查转录历史,或发送到另一个会话。

核心参数:

  • sessions_listkinds?limit?activeMinutes?messageLimit?(0 = 无)
  • sessions_historysessionKey(或 sessionId)、limit?includeTools?
  • sessions_sendsessionKey(或 sessionId)、messagetimeoutSeconds?(0 = fire-and-forget)
  • sessions_spawntasklabel?runtime?agentId?model?thinking?cwd?runTimeoutSeconds?thread?mode?cleanup?
  • session_statussessionKey?(默认当前;接受 sessionId)、model?default 清除覆盖)

注意:

  • main 是规范的直接聊天键;全局/未知被隐藏。
  • messageLimit > 0 获取每个会话的最后 N 条消息(过滤工具消息)。
  • 会话目标由 tools.sessions.visibility 控制(默认 tree:当前会话 + 生成子代理会话)。如果您为多个用户运行共享代理,考虑设置 tools.sessions.visibility: "self" 以防止跨会话浏览。
  • sessions_sendtimeoutSeconds > 0 时等待最终完成。
  • 传递/宣布在完成后进行,是最佳努力;status: "ok" 确认代理运行完成,而不是宣布已送达。
  • sessions_spawn 支持 runtime: "subagent" | "acp"subagent 默认)。关于 ACP 运行时行为,请参阅 ACP 代理
  • sessions_spawn 启动子代理运行并将回复发布回请求者聊天。
    • 支持一次性模式(mode: "run")和持久线程绑定模式(mode: "session" 带有 thread: true)。
    • 如果 thread: true 且省略 mode,模式默认为 session
    • mode: "session" 需要 thread: true
    • 如果省略 runTimeoutSeconds,OpenClaw 在设置时使用 agents.defaults.subagents.runTimeoutSeconds;否则超时默认为 0(无超时)。
    • Discord 线程绑定流程取决于 session.threadBindings.*channels.discord.threadBindings.*
    • 回复格式包括 StatusResult 和紧凑统计。
    • Result 是助手完成文本;如果缺少,则使用最新 toolResult 作为后备。
    • 手动完成模式直接首先发送,带有暂挂后备和瞬态故障重试(status: "ok" 表示运行完成,不是宣布送达)。
  • sessions_spawn 非阻塞并立即返回 status: "accepted"
  • sessions_send 运行回复-乒乓(回复 REPLY_SKIP 停止;通过 session.agentToAgent.maxPingPongTurns 最大轮次,0-5)。
  • 乒乓后,目标代理运行宣布步骤;回复 ANNOUNCE_SKIP 抑制宣布。
  • 沙盒夹紧:当当前会话被沙盒化且 agents.defaults.sandbox.sessionToolsVisibility: "spawned" 时,OpenClaw 将 tools.sessions.visibility 夹紧为 tree

agents_list

列出当前会话可能使用 sessions_spawn 定位的代理 ID。

注意:

  • 结果受每代理允许列表限制(agents.list[].subagents.allowAgents)。
  • 配置 ["*"] 时,工具包含所有配置的代理并标记 allowAny: true

参数(通用)

网关支持工具(canvasnodescron):

  • gatewayUrl(默认 ws://127.0.0.1:18789
  • gatewayToken(如果启用认证)
  • timeoutMs

注意:当设置 gatewayUrl 时,明确包含 gatewayToken。工具不继承配置或环境凭据进行覆盖,并且缺少明确凭据是错误。

浏览器工具:

  • profile(可选;默认为 browser.defaultProfile
  • targetsandbox | host | node
  • node(可选;固定特定节点 id/名称)

推荐的代理流程

浏览器自动化:

  1. browserstatus / start
  2. snapshot(ai 或 aria)
  3. act(click/type/press)
  4. screenshot 如果需要视觉确认

Canvas 渲染:

  1. canvaspresent
  2. a2ui_push(可选)
  3. snapshot

节点定位:

  1. nodesstatus
  2. describe 选择节点
  3. notify / run / camera_snap / screen_record

安全

  • 避免直接 system.run;仅在明确用户同意时使用 nodesrun
  • 尊重用户对摄像头/屏幕捕获的同意。
  • 在调用媒体命令之前使用 status/describe 确保权限。

工具如何呈现给代理

工具通过两个并行通道公开:

  1. 系统提示文本:人类可读的列表 + 指导。
  2. 工具模式:发送到模型 API 的结构化函数定义。

这意味着代理既能看到”存在哪些工具”也能看到”如何调用它们”。如果工具没有出现在系统提示或模式中,模型就无法调用它。

相关链接