Documentation Index
Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt
Use this file to discover all available pages before exploring further.
tools.* 配置键和自定义提供商 / 基础 URL 设置。关于智能体、渠道和其他顶层配置键,请参阅配置参考。
工具
工具配置档
tools.profile 会在 tools.allow/tools.deny 之前设置基础允许列表:
本地新手引导会在未设置时将新的本地配置默认设为
tools.profile: "coding"(已有的显式配置档会保留)。| 配置档 | 包含 |
|---|---|
minimal | 仅 session_status |
coding | group:fs, group:runtime, group:web, group:sessions, group:memory, cron, image, image_generate, video_generate |
messaging | group:messaging, sessions_list, sessions_history, sessions_send, session_status |
full | 无限制(与未设置相同) |
工具组
| 组 | 工具 |
|---|---|
group:runtime | exec, process, code_execution(bash 可作为 exec 的别名) |
group:fs | read, write, edit, apply_patch |
group:sessions | sessions_list, sessions_history, sessions_send, sessions_spawn, sessions_yield, subagents, session_status |
group:memory | memory_search, memory_get |
group:web | web_search, x_search, web_fetch |
group:ui | browser, canvas |
group:automation | heartbeat_respond, cron, gateway |
group:messaging | message |
group:nodes | nodes |
group:agents | agents_list, update_plan |
group:media | image, image_generate, music_generate, video_generate, tts |
group:openclaw | 所有内置工具(不包括提供商插件) |
tools.allow / tools.deny
全局工具允许 / 拒绝策略(拒绝优先)。不区分大小写,支持 * 通配符。即使 Docker 沙箱关闭也会应用。
write 和 apply_patch 是独立的工具 ID。allow: ["write"] 也会为兼容模型启用 apply_patch,但 deny: ["write"] 不会拒绝 apply_patch。要阻止所有文件变更,请拒绝 group:fs,或显式列出每个会变更文件的工具:
tools.byProvider
进一步限制特定提供商或模型的工具。顺序:基础配置档 → 提供商配置档 → 允许 / 拒绝。
tools.toolsBySender
限制特定请求者身份可用的工具。这是在渠道访问控制之上的纵深防御;sender 值必须来自渠道适配器,而不是消息文本。
channel:<channelId>:<senderId>、id:<senderId>、e164:<phone>、username:<handle>、name:<displayName> 或 "*"。渠道 ID 是规范的 OpenClaw ID;teams 等别名会规范化为 msteams。旧版无前缀键仅按 id: 接受。匹配顺序为 channel+id、id、e164、username、name,然后是通配符。
当匹配时,按智能体设置的 agents.list[].tools.toolsBySender 会覆盖全局 sender 匹配,即使策略是空的 {}。
tools.elevated
控制沙箱外的提权 exec 访问:
- 按智能体覆盖(
agents.list[].tools.elevated)只能进一步限制。 /elevated on|off|ask|full会按会话存储状态;内联指令仅应用于单条消息。- 提权
exec会绕过沙箱隔离,并使用配置的逃逸路径(默认是gateway,当 exec 目标是node时为node)。
tools.exec
tools.loopDetection
Tool-loop 安全检查默认禁用。设置 enabled: true 以激活检测。设置可以在 tools.loopDetection 中全局定义,并可在 agents.list[].tools.loopDetection 为每个智能体覆盖。
为循环分析保留的最大工具调用历史记录。
用于警告的重复无进展模式阈值。
用于阻断关键循环的更高重复阈值。
任何无进展运行的硬停止阈值。
对重复的相同工具/相同参数调用发出警告。
对已知轮询工具(
process.poll、command_status 等)发出警告/阻断。对交替无进展的成对模式发出警告/阻断。
tools.web
tools.media
配置入站媒体理解(图像/音频/视频):
Media model entry fields
Media model entry fields
提供商条目(
type: "provider" 或省略):provider:API 提供商 ID(openai、anthropic、google/gemini、groq等)model:模型 ID 覆盖profile/preferredProfile:auth-profiles.json配置文件选择
type: "cli"):command:要运行的可执行文件args:模板化参数(支持{{MediaPath}}、{{Prompt}}、{{MaxChars}}等;openclaw doctor --fix会将已弃用的{input}占位符迁移到{{MediaPath}})
capabilities:可选列表(image、audio、video)。默认值:openai/anthropic/minimax→ 图像,google→ 图像+音频+视频,groq→ 音频。prompt、maxChars、maxBytes、timeoutSeconds、language:每个条目的覆盖项。- 当智能体调用显式的
image工具时,tools.media.image.timeoutSeconds和匹配的图像模型timeoutSeconds条目也会生效。 - 失败会回退到下一个条目。
auth-profiles.json → 环境变量 → models.providers.*.apiKey。异步完成字段:asyncCompletion.directSend:已弃用的兼容标志。已完成的异步媒体任务仍由请求者会话中介处理,因此智能体会收到结果、决定如何告知用户,并在来源投递需要时使用消息工具。
tools.agentToAgent
tools.sessions
控制会话工具(sessions_list、sessions_history、sessions_send)可以定位哪些会话。
默认值:tree(当前会话 + 由它生成的会话,例如子智能体)。
Visibility scopes
Visibility scopes
self:仅当前会话键。tree:当前会话 + 由当前会话生成的会话(子智能体)。agent:属于当前智能体 ID 的任何会话(如果你在同一智能体 ID 下按发送者运行会话,可能包含其他用户)。all:任何会话。跨智能体定位仍然需要tools.agentToAgent。- 沙箱限制:当当前会话是沙箱隔离的,并且
agents.defaults.sandbox.sessionToolsVisibility="spawned"时,即使tools.sessions.visibility="all",可见性也会被强制为tree。
tools.sessions_spawn
控制 sessions_spawn 的内联附件支持。
附件说明
附件说明
- 附件仅支持
runtime: "subagent"。ACP 运行时会拒绝它们。 - 文件会在子工作区的
.openclaw/attachments/<uuid>/中实体化,并带有.manifest.json。 - 附件内容会自动从转录持久化中脱敏。
- Base64 输入会通过严格的字母表/填充检查和解码前大小保护进行验证。
- 目录权限为
0700,文件权限为0600。 - 清理遵循
cleanup策略:delete始终移除附件;keep仅在retainOnSessionKeep: true时保留附件。
tools.experimental
实验性内置工具标志。默认关闭,除非适用严格 agentic GPT-5 自动启用规则。
planTool:为非平凡的多步骤工作跟踪启用结构化update_plan工具。- 默认值:
false,除非agents.defaults.embeddedPi.executionContract(或单个智能体覆盖项)为 OpenAI 或 OpenAI Codex GPT-5 系列运行设置为"strict-agentic"。设置为true可在该范围外强制开启此工具,设置为false可即使在严格 agentic GPT-5 运行中也保持关闭。 - 启用后,系统提示词还会添加使用指南,让模型只在实质性工作中使用它,并且最多保持一个步骤为
in_progress。
agents.defaults.subagents
model:派生子智能体的默认模型。如果省略,子智能体会继承调用方的模型。allowAgents:当请求方智能体未设置自己的subagents.allowAgents时,sessions_spawn的目标智能体 ID 默认允许列表(["*"]= 任意;默认:仅同一智能体)。runTimeoutSeconds:当工具调用省略runTimeoutSeconds时,sessions_spawn的默认超时(秒)。0表示无超时。announceTimeoutMs:Gateway 网关agent宣告投递尝试的每次调用超时(毫秒)。默认值:120000。瞬态重试可能使总宣告等待时间长于一次配置的超时。- 子智能体工具策略:
tools.subagents.tools.allow/tools.subagents.tools.deny。
自定义提供商和 base URL
OpenClaw 使用内置模型目录。通过配置中的models.providers 或 ~/.openclaw/agents/<agentId>/agent/models.json 添加自定义提供商。
身份验证和合并优先级
身份验证和合并优先级
- 对于自定义身份验证需求,使用
authHeader: true+headers。 - 使用
OPENCLAW_AGENT_DIR(或PI_CODING_AGENT_DIR,一个旧版环境变量别名)覆盖智能体配置根目录。 - 匹配提供商 ID 的合并优先级:
- 非空的智能体
models.jsonbaseUrl值优先。 - 非空的智能体
apiKey值仅在该提供商未在当前配置/身份验证配置文件上下文中由 SecretRef 管理时优先。 - 由 SecretRef 管理的提供商
apiKey值会从源标记刷新(env 引用使用ENV_VAR_NAME,file/exec 引用使用secretref-managed),而不是持久化已解析的密钥。 - 由 SecretRef 管理的提供商 header 值会从源标记刷新(env 引用使用
secretref-env:ENV_VAR_NAME,file/exec 引用使用secretref-managed)。 - 空的或缺失的智能体
apiKey/baseUrl会回退到配置中的models.providers。 - 匹配模型的
contextWindow/maxTokens使用显式配置和隐式目录值中的较高值。 - 匹配模型的
contextTokens会在存在显式运行时上限时保留它;用它在不更改原生模型元数据的情况下限制有效上下文。 - 当你希望配置完全重写
models.json时,使用models.mode: "replace"。 - 标记持久化以源为准:标记从活动源配置快照(解析前)写入,而不是从已解析的运行时密钥值写入。
- 非空的智能体
提供商字段详情
顶层目录
顶层目录
models.mode:提供商目录行为(merge或replace)。models.providers:按提供商 ID 键控的自定义提供商映射。- 安全编辑:对于增量更新,使用
openclaw config set models.providers.<id> '<json>' --strict-json --merge或openclaw config set models.providers.<id>.models '<json-array>' --strict-json --merge。除非传入--replace,否则config set会拒绝破坏性替换。
- 安全编辑:对于增量更新,使用
提供商连接和身份验证
提供商连接和身份验证
请求传输覆盖项
请求传输覆盖项
模型目录条目
模型目录条目
models.providers.*.models:显式提供商模型目录条目。models.providers.*.models.*.input:模型输入模态。纯文本模型使用["text"],原生图像/视觉模型使用["text", "image"]。只有在所选模型标记为支持图像时,图像附件才会注入到智能体轮次中。models.providers.*.models.*.contextWindow:原生模型上下文窗口元数据。这会覆盖该模型的提供商级contextWindow。models.providers.*.models.*.contextTokens:可选的运行时上下文上限。这会覆盖提供商级contextTokens;当你希望有效上下文预算小于模型原生contextWindow时使用它;当两个值不同时,openclaw models list会同时显示这两个值。models.providers.*.models.*.compat.supportsDeveloperRole:可选的兼容性提示。对于带有非空非原生baseUrl(主机不是api.openai.com)的api: "openai-completions",OpenClaw 会在运行时将其强制设为false。空的/省略的baseUrl保持默认 OpenAI 行为。models.providers.*.models.*.compat.requiresStringContent:用于仅字符串 OpenAI 兼容聊天端点的可选兼容性提示。为true时,OpenClaw 会在发送请求前将纯文本messages[].content数组展平为普通字符串。models.providers.*.models.*.compat.strictMessageKeys:用于严格 OpenAI 兼容聊天端点的可选兼容性提示。为true时,OpenClaw 会在发送请求前将外发 Chat Completions 消息对象裁剪为role和content。models.providers.*.models.*.compat.thinkingFormat:可选的思考负载提示。对于顶层enable_thinking使用"qwen";对于支持请求级 chat-template kwargs 的 Qwen 系列 OpenAI 兼容服务器(例如 vLLM),对chat_template_kwargs.enable_thinking使用"qwen-chat-template"。
Amazon Bedrock 设备发现
Amazon Bedrock 设备发现
plugins.entries.amazon-bedrock.config.discovery:Bedrock 自动设备发现设置根。plugins.entries.amazon-bedrock.config.discovery.enabled:开启/关闭隐式设备发现。plugins.entries.amazon-bedrock.config.discovery.region:用于设备发现的 AWS 区域。plugins.entries.amazon-bedrock.config.discovery.providerFilter:用于定向设备发现的可选提供商 ID 过滤器。plugins.entries.amazon-bedrock.config.discovery.refreshInterval:设备发现刷新的轮询间隔。plugins.entries.amazon-bedrock.config.discovery.defaultContextWindow:已发现模型的回退上下文窗口。plugins.entries.amazon-bedrock.config.discovery.defaultMaxTokens:已发现模型的回退最大输出 token 数。
--custom-image-input 可强制使用支持图像的元数据,传入 --custom-text-input 可强制使用纯文本元数据。
提供商示例
Cerebras (GLM 4.7 / GPT OSS)
Cerebras (GLM 4.7 / GPT OSS)
内置的 对 Cerebras 使用
cerebras provider 插件可以通过 openclaw onboard --auth-choice cerebras-api-key 配置它。仅在覆盖默认值时使用显式 provider 配置。cerebras/zai-glm-4.7;对 Z.AI 直连使用 zai/glm-4.7。Kimi Coding
Kimi Coding
openclaw onboard --auth-choice kimi-code-api-key。Local models (LM Studio)
Local models (LM Studio)
参见 本地模型。简要说明:在高性能硬件上通过 LM Studio Responses API 运行大型本地模型;保留托管模型合并作为回退。
MiniMax M2.7 (direct)
MiniMax M2.7 (direct)
MINIMAX_API_KEY。快捷方式:openclaw onboard --auth-choice minimax-global-api 或 openclaw onboard --auth-choice minimax-cn-api。模型目录默认仅包含 M2.7。在 Anthropic 兼容的流式传输路径上,除非你显式设置 thinking,否则 OpenClaw 默认禁用 MiniMax 思考。/fast on 或 params.fastMode: true 会将 MiniMax-M2.7 重写为 MiniMax-M2.7-highspeed。Moonshot AI (Kimi)
Moonshot AI (Kimi)
baseUrl: "https://api.moonshot.cn/v1" 或 openclaw onboard --auth-choice moonshot-api-key-cn。原生 Moonshot 端点会在共享的 openai-completions 传输协议上声明流式传输用量兼容性,并且 OpenClaw 会根据端点能力而非仅根据内置 provider ID 来启用该行为。OpenCode
OpenCode
OPENCODE_API_KEY(或 OPENCODE_ZEN_API_KEY)。对 Zen 目录使用 opencode/... 引用,对 Go 目录使用 opencode-go/... 引用。快捷方式:openclaw onboard --auth-choice opencode-zen 或 openclaw onboard --auth-choice opencode-go。Synthetic (Anthropic-compatible)
Synthetic (Anthropic-compatible)
/v1(Anthropic 客户端会追加它)。快捷方式:openclaw onboard --auth-choice synthetic-api-key。Z.AI (GLM-4.7)
Z.AI (GLM-4.7)
ZAI_API_KEY。z.ai/* 和 z-ai/* 是可接受的别名。快捷方式:openclaw onboard --auth-choice zai-api-key。- 通用端点:
https://api.z.ai/api/paas/v4 - 编码端点(默认):
https://api.z.ai/api/coding/paas/v4 - 对于通用端点,定义一个带基础 URL 覆盖的自定义 provider。
相关内容
- 配置 — agents
- 配置 — channels
- 配置参考 — 其他顶层键
- 工具和插件