工具
工具 (OpenClaw)
OpenClaw 提供一流的代理工具,用于浏览器、画布、节点和定时任务。
这些工具取代了旧的 openclaw-* 技能:工具已类型化,无需 shell 调用,
代理应直接使用它们。
禁用工具
你可以在 openclaw.json 中通过 tools.allow / tools.deny 全局允许/拒绝工具
(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 命令),超越核心集合。 请参阅 插件 了解安装 + 配置,以及 技能 了解如何 将工具使用指南注入提示词。一些插件随工具附带自己的技能 (例如,语音通话插件)。
可选插件工具:
- Lobster:带可恢复审批的类型化工作流运行时(需要网关主机上的 Lobster CLI)。
- LLM Task:仅 JSON 的 LLM 步骤,用于结构化工作流输出(可选模式验证)。
- Diffs:只读差异查看器和 PNG 或 PDF 文件渲染器,用于前后文本或统一补丁。
工具清单
apply_patch
在一个或多个文件中应用结构化补丁。用于多块编辑。
实验性:通过 tools.exec.applyPatch.enabled 启用(仅限 OpenAI 模型)。
tools.exec.applyPatch.workspaceOnly 默认为 true(工作区包含)。仅当你有意想让 apply_patch 在工作区目录之外写入/删除时,才将其设置为 false。
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 Companion 应用或无头节点主机(openclaw node run)。- 网关/节点审批和允许列表:Exec 审批。
process
管理后台 exec 会话。
核心操作:
list、poll、log、write、kill、clear、remove
注意:
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。
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/text)。
核心参数:
url(必需)extractMode(markdown|text)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 操作: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)。 snapshot在安装 Playwright 时默认为ai;使用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
驱动节点画布(present、eval、snapshot、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_list、camera_snap、camera_clip、screen_recordlocation_get、notifications_list、notifications_actiondevice_status、device_info、device_permissions、device_health
注意:
- 相机/屏幕命令需要节点应用在前台。
- 图像返回图像块 +
MEDIA:<path>。 - 视频返回
FILE:<path>(mp4)。 - 位置返回 JSON 负载(lat/lon/accuracy/timestamp)。
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(可选;默认为 "Describe the image.")model(可选覆盖)maxBytesMb(可选大小限制)
注意:
- 仅在配置了
agents.defaults.imageModel时可用(主或回退),或当可以从默认模型 + 配置的 auth 推断隐式图像模型时(尽力配对)。 - 直接使用图像模型(独立于主聊天模型)。
pdf
分析一个或多个 PDF 文档。
完整行为、限制、配置和示例,请参阅 PDF 工具。
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
管理网关定时任务和唤醒。
核心操作:
status、listadd、update、remove、run、runswake(排队系统事件 + 可选立即心跳)
注意:
add需要完整的定时任务对象(与cron.addRPC 模式相同)。update使用{ jobId, patch }(id接受用于兼容)。
gateway
重启或应用更新到运行的网关进程(原地)。
核心操作:
restart(授权 + 发送SIGUSR1进行进程内重启;openclaw gateway原地重启)config.get/config.schemaconfig.apply(验证 + 写入配置 + 重启 + 唤醒)config.patch(合并部分更新 + 重启 + 唤醒)update.run(运行更新 + 重启 + 唤醒)
注意:
- 使用
delayMs(默认 2000)避免中断正在进行的回复。 restart默认启用;设置commands.restart: false禁用它。
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?、runtime?、agentId?、model?、thinking?、cwd?、runTimeoutSeconds?、thread?、mode?、cleanup?、sandbox?、attachments?、attachAs?session_status:sessionKey?(默认当前;接受sessionId)、model?(default清除覆盖)
注意:
main是规范直接聊天键;global/unknown 隐藏。messageLimit > 0获取每个会话的最后 N 条消息(工具消息已过滤)。- 会话定位由
tools.sessions.visibility控制(默认tree:当前会话 + 生成的子代理会话)。如果你为多个用户运行共享代理,考虑设置tools.sessions.visibility: "self"以防止跨会话浏览。 sessions_send在timeoutSeconds > 0时等待最终完成。- 交付/宣布在完成之后发生,是尽力的;
status: "ok"确认代理运行完成,而不是宣布已交付。 sessions_spawn支持runtime: "subagent" | "acp"(subagent默认)。对于 ACP 运行时行为,请参阅 ACP 代理。sessions_spawn启动子代理运行并发布宣布回复回请求者聊天。- 支持一次性模式(
mode: "run")和持久线程绑定模式(mode: "session"且thread: true)。 - 如果
thread: true且省略mode,mode 默认为session。 mode: "session"需要thread: true。- 如果省略
runTimeoutSeconds,OpenClaw 在设置时使用agents.defaults.subagents.runTimeoutSeconds;否则超时默认为0(无超时)。 - Discord 线程绑定流取决于
session.threadBindings.*和channels.discord.threadBindings.*。 - 回复格式包括
Status、Result和紧凑统计。 Result是助手完成文本;如果缺失,使用最新toolResult作为回退。
- 支持一次性模式(
- 手动完成模式生成直接首先发送,带有队列回退和瞬态故障重试(
status: "ok"表示运行完成,而不是宣布交付)。 sessions_spawn支持内联文件附件,仅用于子代理运行时(ACP 拒绝它们)。每个附件有name、content和可选encoding(utf8或base64)和mimeType。文件在子工作区的.openclaw/attachments/<uuid>/中实现,带有.manifest.json元数据文件。工具返回收据,包含count、totalBytes、每个文件的sha256和relDir。附件内容自动从转录持久化中编辑。- 通过
tools.sessions_spawn.attachments配置限制(enabled、maxTotalBytes、maxFiles、maxFileBytes、retainOnSessionKeep)。 attachAs.mountPath是未来挂载实现的保留提示。
- 通过
sessions_spawn是非阻塞的,立即返回status: "accepted"。sessions_send运行回复 - 回 ping-pong(回复REPLY_SKIP停止;最大轮数通过session.agentToAgent.maxPingPongTurns,0-5)。- ping-pong 之后,目标代理运行宣布步骤;回复
ANNOUNCE_SKIP抑制宣布。 - 沙盒钳制:当当前会话沙盒化且
agents.defaults.sandbox.sessionToolsVisibility: "spawned"时,OpenClaw 将tools.sessions.visibility钳制为tree。
agents_list
列出当前会话可以使用 sessions_spawn 定位的代理 id。
注意:
- 结果限制为每个代理的允许列表(
agents.list[].subagents.allowAgents)。 - 当配置
["*"]时,工具包括所有配置的代理并标记allowAny: true。
参数(通用)
网关支持的工具(canvas、nodes、cron):
gatewayUrl(默认ws://127.0.0.1:18789)gatewayToken(如果启用 auth)timeoutMs
注意:设置 gatewayUrl 时,显式包含 gatewayToken。工具不继承配置
或环境凭证用于覆盖,缺少显式凭证是错误。
浏览器工具:
profile(可选;默认为browser.defaultProfile)target(sandbox|host|node)node(可选;固定特定节点 id/名称)
推荐的代理流程
浏览器自动化:
browser→status/startsnapshot(ai 或 aria)act(click/type/press)- 如果需要视觉确认,使用
screenshot
画布渲染:
canvas→presenta2ui_push(可选)snapshot
节点定位:
nodes→status- 在选定的节点上使用
describe notify/run/camera_snap/screen_record
安全
- 避免直接
system.run;仅在明确用户同意时使用nodes→run。 - 尊重相机/屏幕捕获的知情同意。
- 在调用媒体命令之前使用
status/describe确保权限。
工具如何呈现给代理
工具通过两个并行渠道暴露:
- 系统提示文本:人类可读的列表 + 指南。
- 工具模式:发送到模型 API 的结构化函数定义。
这意味着代理同时看到"存在哪些工具"和"如何调用它们"。如果工具 未出现在系统提示或模式中,模型无法调用它。