Documentation Index
Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt
Use this file to discover all available pages before exploring further.
tools.* 設定鍵和自訂提供者 / base-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 | 所有內建工具(不含提供者 Plugins) |
tools.allow / tools.deny
全域工具允許/拒絕政策(拒絕優先)。不區分大小寫,支援 * 萬用字元。即使 Docker 沙箱關閉也會套用。
write 和 apply_patch 是不同的工具 ID。allow: ["write"] 也會為相容模型啟用 apply_patch,但 deny: ["write"] 不會拒絕 apply_patch。若要封鎖所有檔案變更,請拒絕 group:fs 或明確列出每個會變更檔案的工具:
tools.byProvider
進一步限制特定提供者或模型的工具。順序:基礎設定檔 → 提供者設定檔 → 允許/拒絕。
tools.elevated
控制沙箱外的提升權限 exec 存取:
- 個別代理覆寫(
agents.list[].tools.elevated)只能進一步限制。 /elevated on|off|ask|full會依工作階段儲存狀態;行內指令只套用到單一訊息。- 提升權限的
exec會繞過沙箱,並使用設定的逃逸路徑(預設為gateway,或當 exec 目標是node時為node)。
tools.exec
tools.loopDetection
工具迴圈安全檢查預設停用。設定 enabled: true 可啟用偵測。設定可以在 tools.loopDetection 中全域定義,並在每個代理的 agents.list[].tools.loopDetection 覆寫。
保留用於迴圈分析的最大工具呼叫歷史記錄。
重複無進展模式的警告臨界值。
用於封鎖嚴重迴圈的較高重複臨界值。
任何無進展執行的硬性停止臨界值。
對重複的相同工具/相同引數呼叫發出警告。
對已知輪詢工具(
process.poll、command_status 等)發出警告/封鎖。對交替出現的無進展配對模式發出警告/封鎖。
tools.web
tools.media
設定傳入媒體理解(圖片/音訊/影片):
媒體模型項目欄位
媒體模型項目欄位
提供者項目(
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:個別項目覆寫。tools.media.image.timeoutSeconds和相符的圖片模型timeoutSeconds項目,也會在代理呼叫明確的image工具時套用。- 失敗時會退回到下一個項目。
auth-profiles.json → 環境變數 → models.providers.*.apiKey。非同步完成欄位:asyncCompletion.directSend:已棄用的相容性旗標。完成的非同步媒體任務會維持由請求者工作階段介入,讓代理接收結果、決定如何告知使用者,並在來源傳遞需要時使用訊息工具。
tools.agentToAgent
tools.sessions
控制哪些工作階段可由工作階段工具(sessions_list、sessions_history、sessions_send)設為目標。
預設值:tree(目前工作階段 + 由它產生的工作階段,例如子代理)。
可見性範圍
可見性範圍
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
實驗性內建工具旗標。除非套用嚴格代理式 GPT-5 自動啟用規則,否則預設關閉。
planTool:為非瑣碎的多步驟工作追蹤啟用結構化update_plan工具。- 預設:
false,除非 OpenAI 或 OpenAI Codex GPT-5 系列執行的agents.defaults.embeddedPi.executionContract(或每個代理的覆寫)設為"strict-agentic"。設為true可在該範圍外強制開啟工具,或設為false即使對嚴格代理式 GPT-5 執行也保持關閉。 - 啟用時,系統提示也會加入使用指引,讓模型只在大量工作時使用它,並最多只保留一個步驟為
in_progress。
agents.defaults.subagents
model:產生的子代理的預設模型。若省略,子代理會繼承呼叫者的模型。allowAgents:當請求代理未設定自己的subagents.allowAgents時,sessions_spawn的目標代理 ID 預設允許清單(["*"]= 任意;預設:僅相同代理)。runTimeoutSeconds:當工具呼叫省略runTimeoutSeconds時,sessions_spawn的預設逾時(秒)。0表示沒有逾時。- 每個子代理的工具策略:
tools.subagents.tools.allow/tools.subagents.tools.deny。
自訂供應商與基礎 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_VAR_NAME,檔案/exec 參照的secretref-managed)重新整理,而不是持久化已解析的祕密。 - 由 SecretRef 管理的供應商標頭值會從來源標記(環境變數參照的
secretref-env:ENV_VAR_NAME,檔案/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:選用的相容性提示。對於api: "openai-completions"且具有非空非原生baseUrl(主機不是api.openai.com)的情況,OpenClaw 會在執行階段強制將此值設為false。空白/省略的baseUrl會保留預設 OpenAI 行為。models.providers.*.models.*.compat.requiresStringContent:字串專用 OpenAI 相容聊天端點的選用相容性提示。設為true時,OpenClaw 會在傳送請求前,將純文字messages[].content陣列扁平化為一般字串。
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:探索到的模型的後援最大輸出權杖數。
--custom-image-input 以強制使用支援圖片的中繼資料,或傳入 --custom-text-input 以強制使用文字專用中繼資料。
供應商範例
Cerebras(GLM 4.7 / GPT OSS)
Cerebras(GLM 4.7 / GPT OSS)
隨附的 Cerebras 請使用
cerebras 供應商 Plugin 可透過 openclaw onboard --auth-choice cerebras-api-key 設定此項。只有在覆寫預設值時才使用明確的供應商設定。cerebras/zai-glm-4.7;Z.AI 直連請使用 zai/glm-4.7。Kimi 編碼
Kimi 編碼
openclaw onboard --auth-choice kimi-code-api-key。本機模型 (LM Studio)
本機模型 (LM Studio)
請參閱本機模型。簡而言之:在高規格硬體上透過 LM Studio Responses API 執行大型本機模型;保留已合併的託管模型作為備援。
MiniMax M2.7(直連)
MiniMax M2.7(直連)
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 會依據端點能力啟用此行為,不只依賴內建提供者 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 相容)
Synthetic(Anthropic 相容)
/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。
相關
- 設定 — agents
- 設定 — channels
- 設定參考 — 其他頂層鍵
- 工具與 plugins