工具 (OpenClaw)
OpenClaw 为浏览器、画布、节点和定时任务提供一流代理工具。 这些工具取代了旧的 openclaw-* 技能:工具具有类型定义,无需外壳执行, 代理应直接依赖它们。
禁用工具
您可以通过 openclaw.json 中的 tools.allow / tools.deny 全局允许/拒绝工具 (拒绝优先)。这可防止不允许的工具被发送到模型提供商。
{
tools: { deny: ["browser"] }
}注意事项:
- 匹配不区分大小写。
- 支持
*通配符("*"表示所有工具)。 - 如果
tools.allow仅引用未知或未加载的插件工具名称,OpenClaw 会记录警告并忽略白名单,以便核心工具保持可用。
工具配置文件(基本白名单)
tools.profile 在 tools.allow/tools.deny 之前设置基本工具白名单。 每代理覆盖:agents.list[].tools.profile。
配置文件:
minimal:仅session_statuscoding:group:fs,group:runtime,group:sessions,group:memory,imagemessaging:group:messaging,sessions_list,sessions_history,sessions_send,session_statusfull:无限制(与未设置相同)
示例(默认仅消息传递,也允许 Slack + Discord 工具):
{
tools: {
profile: "messaging",
allow: ["slack", "discord"]
}
}示例(编码配置文件,但在各处拒绝 exec/process):
{
tools: {
profile: "coding",
deny: ["group:runtime"]
}
}示例(全局编码配置文件,仅消息传递支持代理):
{
tools: { profile: "coding" },
agents: {
list: [
{
id: "support",
tools: { profile: "messaging", allow: ["slack"] }
}
]
}
}特定提供商工具策略
使用 tools.byProvider 在不更改全局默认值的情况下,为特定提供商 (或单个 provider/model)进一步限制工具。 每代理覆盖: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"] }
}
}
}示例(针对单个提供商的代理特定覆盖):
{
agents: {
list: [
{
id: "support",
tools: {
byProvider: {
"google-antigravity": { allow: ["message", "sessions_list"] }
}
}
}
]
}
}工具组(缩写)
工具策略(全局、代理、沙盒)支持展开为多个工具的 group:* 条目。 在 tools.allow / tools.deny 中使用这些。
可用组:
group:runtime:exec,bash,processgroup:fs:read,write,edit,apply_patchgroup:sessions:sessions_list,sessions_history,sessions_send,sessions_spawn,session_statusgroup:memory:memory_search,memory_getgroup:web:web_search,web_fetchgroup:ui:browser,canvasgroup:automation:cron,gatewaygroup:messaging:messagegroup:nodes:nodesgroup:openclaw: 所有内置 OpenClaw 工具(不包括提供商插件)
示例(仅允许文件工具 + 浏览器):
{
tools: {
allow: ["group:fs", "browser"]
}
}插件 + 工具
插件可以注册超出核心集的附加工具(和 CLI 命令)。 有关安装 + 配置,请参见插件,有关如何将工具使用指导注入提示的信息,请参见技能。 某些插件随工具一起提供自己的技能(例如,语音通话插件)。
可选插件工具:
工具清单
apply_patch
跨一个或多个文件应用结构化补丁。用于多块编辑。 实验性:通过 tools.exec.applyPatch.enabled 启用(仅限 OpenAI 模型)。
exec
在工作区中运行 shell 命令。
核心参数:
command(必需)yieldMs(超时后自动后台运行,默认 10000)background(立即后台运行)timeout(秒;超过此时间杀死进程,默认 1800)elevated(布尔值;如果提升模式已启用/允许,则在主机上运行;仅在代理沙盒化时改变行为)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。 elevated受tools.elevated以及任何agents.list[].tools.elevated覆盖控制(两者都必须允许)并是host=gateway+security=full的别名。elevated仅在代理沙盒化时改变行为(否则无操作)。host=node可以定位 macOS 伴侣应用程序或无头节点主机(openclaw node run)。- 网关/节点审批和白名单:执行审批。
process
管理后台执行会话。
核心操作:
list,poll,log,write,kill,clear,remove
注意事项:
poll完成时返回新输出和退出状态。log支持基于行的offset/limit(省略offset以获取最后 N 行)。process按代理范围划分;其他代理的会话不可见。
web_search
使用 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/文本)。
核心参数:
url(必需)extractMode(markdown|text)maxChars(截断长页面)
注意事项:
- 通过
tools.web.fetch.enabled启用。 - 响应被缓存(默认 15 分钟)。
- 对于 JS 密集型网站,首选浏览器工具。
- 有关设置,请参见Web 工具。
- 有关可选的反机器人回退,请参见Firecrawl。
browser
控制专用的 clawd 浏览器。
核心操作:
status,start,stop,tabs,open,focus,closesnapshot(aria/ai)screenshot(返回图像块 +MEDIA:<path>)act(UI 操作:点击/输入/按下/悬停/拖拽/选择/填充/调整大小/等待/评估)navigate,console,pdf,upload,dialog
配置文件管理:
profiles— 列出所有具有状态的浏览器配置文件create-profile— 创建具有自动分配端口的新配置文件(或cdpUrl)delete-profile— 停止浏览器,删除用户数据,从配置中移除(仅本地)reset-profile— 终止配置文件端口上的孤立进程(仅本地)
常用参数:
controlUrl(从配置中默认)profile(可选;默认为browser.defaultProfile) 注意事项:- 需要
browser.enabled=true(默认为true;设置false以禁用)。 - 使用
browser.controlUrl,除非显式传递controlUrl。 - 所有操作都接受可选的
profile参数以支持多实例。 - 省略
profile时,使用browser.defaultProfile(默认为 "chrome")。 - 配置文件名称:仅小写字母数字 + 连字符(最大 64 个字符)。
- 端口范围:18800-18899(最多约 100 个配置文件)。
- 远程配置文件仅支持附加(无启动/停止/重置)。
- 安装 Playwright 时
snapshot默认为ai;使用aria获取无障碍树。 snapshot还支持角色快照选项(interactive,compact,depth,selector),返回类似e12的引用。act需要来自snapshot的ref(AI 快照的数字12,或角色快照的e12);对于罕见的 CSS 选择器需求使用evaluate。- 默认避免
act→wait;仅在特殊情况(没有可靠的 UI 状态可等待)下使用。 upload可选地传递ref以在准备后自动点击。upload还支持inputRef(aria 引用)或element(CSS 选择器)来直接设置<input type="file">。
canvas
驱动节点 Canvas(展示、评估、快照、A2UI)。
核心操作:
present,hide,navigate,evalsnapshot(返回图像块 +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"。
nodes
发现和定位配对节点;发送通知;捕获摄像头/屏幕。
核心操作:
status,describepending,approve,reject(配对)notify(macOSsystem.notify)run(macOSsystem.run)camera_snap,camera_clip,screen_recordlocation_get
注意事项:
- 摄像头/屏幕命令需要节点应用程序在前台运行。
- 图像返回图像块 +
MEDIA:<path>。 - 视频返回
FILE:<path>(mp4)。 - 位置返回 JSON 负载(纬度/经度/精度/时间戳)。
run参数:commandargv 数组;可选的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
使用配置的图像模型分析图像。
核心参数:
image(必需的路径或 URL)prompt(可选;默认为 "描述图像。")model(可选覆盖)maxBytesMb(可选大小限制)
注意事项:
- 仅在配置了
agents.defaults.imageModel(主要或备用)时可用,或者可以从您的默认模型 + 配置的身份验证推断出隐式图像模型时(尽力配对)。 - 直接使用图像模型(独立于主聊天模型)。
message
在 Discord/Google Chat/Slack/Telegram/WhatsApp/Signal/iMessage/MS Teams 间发送消息和频道操作。
核心操作:
send(文本 + 可选媒体;MS Teams 还支持用于自适应卡片的card)poll(WhatsApp/Discord/MS Teams 投票)react/reactions/read/edit/deletepin/unpin/list-pinspermissionsthread-create/thread-list/thread-replysearchstickermember-info/role-infoemoji-list/emoji-upload/sticker-uploadrole-add/role-removechannel-info/channel-listvoice-statusevent-list/event-createtimeout/kick/ban
注意事项:
send通过网关路由 WhatsApp;其他频道直接发送。poll对 WhatsApp 和 MS Teams 使用网关;Discord 投票直接发送。- 当消息工具调用绑定到活动聊天会话时,发送受限于该会话的目标,以避免跨上下文泄漏。
cron
管理网关 cron 作业和唤醒。
核心操作:
status,listadd,update,remove,run,runswake(排队系统事件 + 可选的即时心跳)
注意事项:
add期望一个完整的 cron 作业对象(与cron.addRPC 相同的架构)。update使用{ id, patch }。
gateway
重启或对运行中的网关进程应用更新(就地)。
核心操作:
restart(授权 + 发送SIGUSR1以进行进程内重启;openclaw gateway就地重启)config.get/config.schemaconfig.apply(验证 + 写入配置 + 重启 + 唤醒)config.patch(合并部分更新 + 重启 + 唤醒)update.run(运行更新 + 重启 + 唤醒)
注意事项:
- 使用
delayMs(默认为 2000)以避免中断正在进行的回复。 restart默认禁用;通过commands.restart: true启用。
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_send在timeoutSeconds > 0时等待最终完成。- 交付/公告在完成后发生,属于尽力而为;
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。
参数(通用)
网关支持的工具(canvas, nodes, cron):
gatewayUrl(默认ws://127.0.0.1:18789)gatewayToken(如果启用了身份验证)timeoutMs
浏览器工具:
controlUrl(从配置中默认)
推荐的代理流程
浏览器自动化:
browser→status/startsnapshot(ai 或 aria)act(点击/输入/按下)- 如需视觉确认,使用
screenshot
画布渲染:
canvas→presenta2ui_push(可选)snapshot
节点定位:
nodes→status- 在选定的节点上执行
describe notify/run/camera_snap/screen_record
安全性
- 避免直接使用
system.run;仅在用户明确同意的情况下使用nodes→run。 - 尊重用户对摄像头/屏幕捕获的同意。
- 在调用媒体命令之前使用
status/describe确保权限。
工具如何呈现给代理
工具有两个并行渠道暴露:
- 系统提示文本:人类可读的列表 + 指导。
- 工具架构:发送到模型 API 的结构化函数定义。
这意味着代理可以看到"什么工具存在"和"如何调用它们"。如果一个工具没有出现在系统提示或架构中,模型就无法调用它。