跳转到内容

工具

OpenClaw 暴露了用于浏览器、画布、节点和定时任务的 一等 Agent 工具。 这些取代了旧的 openclaw-* 技能:工具是类型化的,无需 Shell 调用,Agent 应直接依赖它们。

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

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

注意:

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

tools.profiletools.allow/tools.deny 之前设置 基础工具白名单。 每个 Agent 的覆盖:agents.list[].tools.profile

配置文件:

  • minimal: 仅 session_status
  • coding: group:fs, group:runtime, group:sessions, group:memory, image
  • messaging: group:messaging, sessions_list, sessions_history, sessions_send, session_status
  • full: 无限制(同未设置)

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

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

示例(编码配置文件,但在任何地方都拒绝 exec/process):

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

示例(全局编码配置文件,仅消息支持 Agent):

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

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

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

示例(保持全局编码配置文件,但为 Google Antigravity 提供最少工具):

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

示例(针对不稳定端点的特定提供商/模型白名单):

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

示例(针对单个提供商的特定 Agent 覆盖):

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

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

可用组:

  • group:runtime: exec, bash, process
  • group:fs: read, write, edit, apply_patch
  • group:sessions: sessions_list, sessions_history, sessions_send, sessions_spawn, session_status
  • group:memory: memory_search, memory_get
  • group:web: web_search, web_fetch
  • group:ui: browser, canvas
  • group:automation: cron, gateway
  • group:messaging: message
  • group:nodes: nodes
  • group:openclaw: 所有内置 OpenClaw 工具(不包括提供商插件)

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

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

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

可选插件工具:

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

跨一个或多个文件应用结构化补丁。用于多块编辑。 实验性:通过 tools.exec.applyPatch.enabled 启用(仅限 OpenAI 模型)。

在工作区中运行 Shell 命令。

核心参数:

  • command (必填)
  • yieldMs (超时后自动转入后台,默认 10000)
  • background (立即后台)
  • timeout (秒;如果超出则杀死进程,默认 1800)
  • elevated (布尔值;如果启用/允许提升模式,则在主机上运行;仅当 Agent 沙盒化时才会改变行为)
  • host (sandbox | gateway | node)
  • security (deny | allowlist | full)
  • ask (off | 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 仅当 Agent 沙盒化时才会改变行为(否则它是无操作)。
  • host=node 可以针对 macOS 伴侣应用或无头节点主机 (openclaw node run)。
  • 网关/节点批准和白名单:Exec 批准

管理后台 exec 会话。

核心操作:

  • list, poll, log, write, kill, clear, remove

注意:

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

使用 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 工具

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

核心参数:

  • url (必填)
  • extractMode (markdown | text)
  • maxChars (截断长页面)

注意:

  • 通过 tools.web.fetch.enabled 启用。
  • 响应被缓存(默认 15 分钟)。
  • 对于重 JS 站点,首选 browser 工具。
  • 有关设置,请参阅 Web 工具
  • 有关可选的反机器人回退,请参阅 Firecrawl

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

核心操作:

  • status, start, stop, tabs, open, focus, close
  • snapshot (aria/ai)
  • screenshot (返回图像块 + MEDIA:<path>)
  • act (UI 操作: click/type/press/hover/drag/select/fill/resize/wait/evaluate)
  • navigate, console, pdf, upload, dialog

配置文件管理:

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

通用参数:

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

驱动节点 Canvas(演示、评估、快照、A2UI)。

核心操作:

  • present, hide, navigate, eval
  • snapshot (返回图像块 + MEDIA:<path>)
  • a2ui_push, a2ui_reset

注意:

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

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

核心操作:

  • status, describe
  • pending, approve, reject (配对)
  • notify (macOS system.notify)
  • run (macOS system.run)
  • camera_snap, camera_clip, screen_record
  • location_get

注意:

  • 摄像头/屏幕命令需要节点应用处于前台。
  • 图像返回图像块 + MEDIA:<path>
  • 视频返回 FILE:<path> (mp4)。
  • 位置返回 JSON 负载(经度/纬度/精度/时间戳)。
  • run 参数:command argv 数组;可选 cwd, env (KEY=VAL), commandTimeoutMs, invokeTimeoutMs, needsScreenRecording

示例 (run):

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

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

核心参数:

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

注意:

  • 仅当配置了 agents.defaults.imageModel(主要或回退),或者可以从您的默认模型 + 配置的身份验证推断出隐式图像模型(尽力配对)时才可用。
  • 直接使用图像模型(独立于主聊天模型)。

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

核心操作:

  • send (文本 + 可选媒体; MS Teams 也支持 card 用于自适应卡片)
  • 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 投票直接发送。
  • 当消息工具调用绑定到活动聊天会话时,发送被限制在该会话的目标,以避免跨上下文泄漏。

管理网关定时任务和唤醒。

核心操作:

  • status, list
  • add, update, remove, run, runs
  • wake (排队系统事件 + 可选立即心跳)

注意:

  • add 需要完整的 cron job 对象(与 cron.add RPC 模式相同)。
  • update 使用 { id, patch }

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

核心操作:

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

注意:

  • 使用 delayMs(默认为 2000)以避免中断正在进行的回复。
  • restart 默认禁用;通过 commands.restart: true 启用。

sessions_list / sessions_history / sessions_send / sessions_spawn / session_status

Section titled “sessions_list / sessions_history / sessions_send / sessions_spawn / session_status”

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

核心参数:

  • sessions_list: kinds?, limit?, activeMinutes?, messageLimit? (0 = 无)
  • sessions_history: sessionKey (或 sessionId), limit?, includeTools?
  • sessions_send: sessionKey (或 sessionId), message, timeoutSeconds? (0 =即发即弃)
  • sessions_spawn: task, label?, agentId?, model?, runTimeoutSeconds?, cleanup?
  • session_status: sessionKey? (默认当前; 接受 sessionId), model? (default 清除覆盖)

注意:

  • main 是规范的直接聊天键;全局/未知被隐藏。
  • messageLimit > 0 获取每个会话的最后 N 条消息(过滤掉工具消息)。
  • sessions_sendtimeoutSeconds > 0 时等待最终完成。
  • 传递/宣布发生在完成之后,并且是尽力而为的;status: "ok" 确认 Agent 运行完成,而不是确认宣布已传递。
  • sessions_spawn 启动子 Agent 运行并将宣布回复发布回请求者聊天。
  • sessions_spawn 是非阻塞的,立即返回 status: "accepted"
  • sessions_send 运行回复-乒乓(回复 REPLY_SKIP 停止;通过 session.agentToAgent.maxPingPongTurns 设置最大轮数,0–5)。
  • 乒乓之后,目标 Agent 运行 宣布步骤;回复 ANNOUNCE_SKIP 以抑制宣布。

列出当前会话可以使用 sessions_spawn 目标的 Agent ID。

注意:

  • 结果受限于每个 Agent 的白名单(agents.list[].subagents.allowAgents)。
  • 当配置为 ["*"] 时,工具包括所有配置的 Agent 并标记 allowAny: true

网关支持的工具 (canvas, nodes, cron):

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

浏览器工具:

  • profile (可选; 默认为 browser.defaultProfile)
  • target (sandbox | 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 的结构化函数定义。

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