跳转到主要内容

工具(OpenClaw)

OpenClaw 提供一等智能体工具,涵盖 browser、canvas、nodes 和 cron。 这些工具替代了旧的 openclaw-* Skills:工具是类型化的,无需 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 使用 minimal 工具):
{
  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 工具(不包括提供商插件)
示例(仅允许文件工具 + browser):
{
  tools: {
    allow: ["group:fs", "browser"],
  },
}

插件 + 工具

插件可以在核心工具集之外注册额外的工具(和 CLI 命令)。 参见插件了解安装和配置,以及Skills了解工具使用指导如何注入到提示词中。某些插件会随工具一起提供自己的 Skills(例如语音通话插件)。 可选插件工具:
  • Lobster:类型化工作流运行时,支持可恢复的审批(需要 Gateway网关主机上安装 Lobster CLI)。
  • LLM Task:用于结构化工作流输出的纯 JSON LLM 步骤(可选 schema 验证)。

工具清单

apply_patch

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

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)。
  • Gateway网关/节点审批和允许列表:Exec 审批

process

管理后台 exec 会话。 核心操作:
  • listpolllogwritekillclearremove
说明:
  • poll 返回新输出,完成时返回退出状态。
  • log 支持基于行的 offset/limit(省略 offset 可获取最后 N 行)。
  • process 按智能体隔离;其他智能体的会话不可见。
使用 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 启用。
  • 响应会被缓存(默认 15 分钟)。
  • 对于 JS 密集型网站,建议使用 browser 工具。
  • 参见 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)。
  • snapshot 在安装了 Playwright 时默认为 ai;使用 aria 获取无障碍树。
  • snapshot 还支持角色快照选项(interactivecompactdepthselector),返回如 e12 的引用。
  • act 需要来自 snapshotref(AI 快照中的数字 12,或角色快照中的 e12);对于少见的 CSS 选择器需求使用 evaluate
  • 默认避免 actwait;仅在特殊情况下使用(没有可靠的 UI 状态可等待时)。
  • upload 可以选择传递 ref 以在准备后自动点击。
  • upload 还支持 inputRef(aria 引用)或 element(CSS 选择器)以直接设置 <input type="file">

canvas

驱动节点 Canvas(展示、执行、快照、A2UI)。 核心操作:
  • presenthidenavigateeval
  • snapshot(返回图像块 + MEDIA:<path>
  • a2ui_pusha2ui_reset
说明:
  • 底层使用 Gateway网关的 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 通过 Gateway网关路由 WhatsApp;其他渠道直接发送。
  • poll 对 WhatsApp 和 MS Teams 使用 Gateway网关;Discord 投票直接发送。
  • 当消息工具调用绑定到活跃的聊天会话时,发送将被限制在该会话的目标范围内,以避免跨上下文泄露。

cron

管理 Gateway网关定时任务和唤醒。 核心操作:
  • statuslist
  • addupdateremoverunruns
  • wake(入队系统事件 + 可选立即心跳)
说明:
  • add 需要完整的 cron 任务对象(与 cron.add RPC 相同的 schema)。
  • update 使用 { id, patch }

gateway

重启或向正在运行的 Gateway网关进程应用更新(原地更新)。 核心操作:
  • 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

列出会话、查看对话历史或向另一个会话发送消息。 核心参数:
  • sessions_listkinds?limit?activeMinutes?messageLimit?(0 = 无)
  • sessions_historysessionKey(或 sessionId)、limit?includeTools?
  • sessions_sendsessionKey(或 sessionId)、messagetimeoutSeconds?(0 = 即发即忘)
  • sessions_spawntasklabel?agentId?model?runTimeoutSeconds?cleanup?
  • session_statussessionKey?(默认当前;接受 sessionId)、model?default 清除覆盖)
说明:
  • main 是规范的直接聊天键;global/unknown 被隐藏。
  • messageLimit > 0 获取每个会话的最后 N 条消息(工具消息被过滤)。
  • timeoutSeconds > 0 时,sessions_send 会等待最终完成。
  • 投递/通告在完成后发生,且为尽力而为;status: "ok" 确认智能体运行已完成,而非通告已送达。
  • sessions_spawn 启动子智能体运行并向请求者聊天发送通告回复。
  • sessions_spawn 是非阻塞的,立即返回 status: "accepted"
  • sessions_send 运行回复往返乒乓(回复 REPLY_SKIP 停止;最大轮次通过 session.agentToAgent.maxPingPongTurns 设置,0–5)。
  • 乒乓结束后,目标智能体运行一个通告步骤;回复 ANNOUNCE_SKIP 可抑制通告。

agents_list

列出当前会话可通过 sessions_spawn 指向的智能体 id。 说明:
  • 结果受每智能体允许列表限制(agents.list[].subagents.allowAgents)。
  • 配置为 ["*"] 时,工具包含所有已配置的智能体并标记 allowAny: true

参数(通用)

Gateway网关支持的工具(canvasnodescron):
  • gatewayUrl(默认 ws://127.0.0.1:18789
  • gatewayToken(如果启用了认证)
  • timeoutMs
Browser 工具:
  • 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. 工具 schema:发送给模型 API 的结构化函数定义。
这意味着智能体同时看到”存在哪些工具”和”如何调用它们”。如果某个工具 未出现在系统提示词或 schema 中,模型将无法调用它。