工具 (OpenClaw)
OpenClaw 提供了 一等代理工具 用于浏览器、画布、节点和定时任务。
这些工具替换了旧的 openclaw-* 技能:工具是类型化的,不使用 shell,
并且代理应直接依赖它们。
禁用工具
您可以通过 tools.allow / tools.deny 在 openclaw.json
中全局允许/拒绝工具(拒绝优先)。这可以防止不允许的工具被发送到模型提供商。
{
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)。- 网关/节点审批和白名单:Exec 审批。
process
管理后台 exec 会话。
核心操作:
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(markdowntext) maxChars(截断长页面)
注意事项:
- 通过
tools.web.fetch.enabled启用。 maxChars受tools.web.fetch.maxCharsCap限制(默认50000)。- 响应会被缓存(默认15分钟)。
- 对于JS密集型网站,建议使用浏览器工具。
- 请参阅Web工具进行设置。
- 请参阅Firecrawl了解可选的反爬虫回退方案。
browser
控制专用的OpenClaw管理的浏览器。
核心操作:
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— 终止配置文件端口上的孤立进程(仅限本地)
常用参数:
profile(可选;默认为browser.defaultProfile)-
target(sandboxhostnode) node(可选;选择特定节点ID/名称) 注意事项:- 需要
browser.enabled=true(默认为true;设置false以禁用)。 - 所有操作接受可选的
profile参数以支持多实例。 - 当省略
profile时,使用browser.defaultProfile(默认为 “chrome”)。 - 配置文件名称:仅小写字母、数字和连字符(最大64个字符)。
- 端口范围:18800-18899(最多约100个配置文件)。
- 远程配置文件仅支持附加(不支持启动/停止/重置)。
- 如果连接了支持浏览器的节点,工具可能会自动路由到它(除非你固定
target)。 snapshot默认为ai当安装了 Playwright;使用aria获取无障碍树。snapshot也支持角色快照选项 (interactive,compact,depth,selector),这些选项返回类似e12的引用。act需要来自snapshot的ref(来自AI快照的数字12或来自角色快照的e12);使用evaluate处理罕见的CSS选择器需求。- 默认避免
act→wait;仅在例外情况下使用(没有可靠的UI状态可供等待)。 upload可选传递一个ref以在武装后自动点击。upload也支持inputRef(aria 引用)或element(CSS 选择器)以直接设置<input type="file">。
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是规范的直接聊天密钥;global/unknown 被隐藏。messageLimit > 0每个会话获取最后 N 条消息(工具消息被过滤)。sessions_send在timeoutSeconds > 0时等待最终完成。- 交付/通告在完成之后进行,并且是尽力而为;
status: "ok"确认代理运行结束,而不是通告已送达。 sessions_spawn启动子代理运行并向请求者聊天发送通告回复。sessions_spawn是非阻塞的,并立即返回status: "accepted"。sessions_send运行回复-pong 乒乓(回复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
注意:当设置了 gatewayUrl 时,显式包含 gatewayToken。工具不会继承配置或环境凭据以进行覆盖,缺少显式凭据是错误。
浏览器工具:
profile(可选;默认为browser.defaultProfile)-
target(sandboxhostnode) node(可选;固定特定节点 ID/名称)
推荐的代理流程
浏览器自动化:
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 的结构化函数定义。
这意味着代理可以看到“有哪些工具存在”以及“如何调用它们”。如果工具没有出现在系统提示或架构中,模型将无法调用它。