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.* khóa cấu hình và thiết lập nhà cung cấp tùy chỉnh / URL cơ sở. Đối với tác tử, kênh và các khóa cấu hình cấp cao nhất khác, hãy xem Tham chiếu cấu hình.
Công cụ
Hồ sơ công cụ
tools.profile đặt một danh sách cho phép cơ sở trước tools.allow/tools.deny:
Quy trình hướng dẫn cục bộ mặc định cấu hình cục bộ mới thành
tools.profile: "coding" khi chưa đặt (các hồ sơ tường minh hiện có được giữ nguyên).| Hồ sơ | Bao gồm |
|---|---|
minimal | chỉ 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 | Không hạn chế (giống như khi chưa đặt) |
Nhóm công cụ
| Nhóm | Công cụ |
|---|---|
group:runtime | exec, process, code_execution (bash được chấp nhận làm bí danh cho 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 | Tất cả công cụ tích hợp sẵn (không bao gồm Plugin của nhà cung cấp) |
tools.allow / tools.deny
Chính sách cho phép/từ chối công cụ toàn cục (deny được ưu tiên). Không phân biệt chữ hoa chữ thường, hỗ trợ ký tự đại diện *. Được áp dụng ngay cả khi Docker sandbox tắt.
write và apply_patch là các mã định danh công cụ riêng biệt. allow: ["write"] cũng bật apply_patch cho các mô hình tương thích, nhưng deny: ["write"] không từ chối apply_patch. Để chặn toàn bộ thay đổi tệp, hãy từ chối group:fs hoặc liệt kê tường minh từng công cụ có khả năng thay đổi:
tools.byProvider
Hạn chế thêm công cụ cho các nhà cung cấp hoặc mô hình cụ thể. Thứ tự: hồ sơ cơ sở → hồ sơ nhà cung cấp → cho phép/từ chối.
tools.toolsBySender
Hạn chế công cụ cho một danh tính người yêu cầu cụ thể. Đây là lớp phòng thủ bổ sung trên kiểm soát truy cập kênh; giá trị người gửi phải đến từ bộ điều hợp kênh, không phải văn bản tin nhắn.
channel:<channelId>:<senderId>, id:<senderId>, e164:<phone>, username:<handle>, name:<displayName>, hoặc "*". Mã định danh kênh là mã định danh OpenClaw chuẩn; các bí danh như teams được chuẩn hóa thành msteams. Các khóa cũ không có tiền tố được chấp nhận chỉ dưới dạng id:. Thứ tự khớp là channel+id, id, e164, username, name, rồi ký tự đại diện.
agents.list[].tools.toolsBySender theo từng tác tử ghi đè kết quả khớp người gửi toàn cục khi nó khớp, ngay cả với chính sách {} trống.
tools.elevated
Kiểm soát quyền truy cập exec nâng cao bên ngoài sandbox:
- Ghi đè theo từng tác tử (
agents.list[].tools.elevated) chỉ có thể hạn chế thêm. /elevated on|off|ask|fulllưu trạng thái theo từng phiên; chỉ thị nội tuyến áp dụng cho một tin nhắn.execnâng cao bỏ qua sandbox và dùng đường thoát đã cấu hình (gatewaytheo mặc định, hoặcnodekhi mục tiêu exec lànode).
tools.exec
tools.loopDetection
Các kiểm tra an toàn vòng lặp công cụ được tắt theo mặc định. Đặt enabled: true để kích hoạt phát hiện. Có thể định nghĩa cài đặt ở phạm vi toàn cục trong tools.loopDetection và ghi đè theo từng tác nhân tại agents.list[].tools.loopDetection.
Lịch sử lệnh gọi công cụ tối đa được giữ lại để phân tích vòng lặp.
Ngưỡng mẫu không có tiến triển lặp lại để cảnh báo.
Ngưỡng lặp lại cao hơn để chặn các vòng lặp nghiêm trọng.
Ngưỡng dừng cứng cho mọi lượt chạy không có tiến triển.
Cảnh báo khi có các lệnh gọi cùng công cụ/cùng đối số lặp lại.
Cảnh báo/chặn trên các công cụ thăm dò đã biết (
process.poll, command_status, v.v.).Cảnh báo/chặn trên các mẫu cặp không có tiến triển luân phiên.
tools.web
tools.media
Cấu hình khả năng hiểu phương tiện đầu vào (hình ảnh/âm thanh/video):
Media model entry fields
Media model entry fields
Mục nhập nhà cung cấp (
type: "provider" hoặc bị bỏ qua):provider: id nhà cung cấp API (openai,anthropic,google/gemini,groq, v.v.)model: ghi đè id mô hìnhprofile/preferredProfile: lựa chọn hồ sơauth-profiles.json
type: "cli"):command: tệp thực thi cần chạyargs: đối số theo mẫu (hỗ trợ{{MediaPath}},{{Prompt}},{{MaxChars}}, v.v.;openclaw doctor --fixdi chuyển các placeholder{input}không còn dùng sang{{MediaPath}})
capabilities: danh sách tùy chọn (image,audio,video). Mặc định:openai/anthropic/minimax→ hình ảnh,google→ hình ảnh+âm thanh+video,groq→ âm thanh.prompt,maxChars,maxBytes,timeoutSeconds,language: ghi đè theo từng mục nhập.tools.media.image.timeoutSecondsvà các mục nhậptimeoutSecondscủa mô hình hình ảnh tương ứng cũng áp dụng khi tác nhân gọi rõ ràng công cụimage.- Lỗi sẽ chuyển dự phòng sang mục nhập tiếp theo.
auth-profiles.json → biến môi trường → models.providers.*.apiKey.Trường hoàn tất bất đồng bộ:asyncCompletion.directSend: cờ tương thích không còn dùng. Các tác vụ phương tiện bất đồng bộ đã hoàn tất vẫn được trung gian qua phiên của người yêu cầu để tác nhân nhận kết quả, quyết định cách báo cho người dùng và sử dụng công cụ tin nhắn khi việc gửi từ nguồn yêu cầu điều đó.
tools.agentToAgent
tools.sessions
Kiểm soát những phiên nào có thể được nhắm mục tiêu bởi các công cụ phiên (sessions_list, sessions_history, sessions_send).
Mặc định: tree (phiên hiện tại + các phiên do phiên đó sinh ra, chẳng hạn như tác nhân con).
Visibility scopes
Visibility scopes
self: chỉ khóa phiên hiện tại.tree: phiên hiện tại + các phiên do phiên hiện tại sinh ra (tác nhân con).agent: bất kỳ phiên nào thuộc về id tác nhân hiện tại (có thể bao gồm người dùng khác nếu bạn chạy phiên theo từng người gửi dưới cùng một id tác nhân).all: bất kỳ phiên nào. Việc nhắm mục tiêu xuyên tác nhân vẫn yêu cầutools.agentToAgent.- Kẹp sandbox: khi phiên hiện tại chạy trong sandbox và
agents.defaults.sandbox.sessionToolsVisibility="spawned", khả năng hiển thị bị buộc thànhtreengay cả khitools.sessions.visibility="all".
tools.sessions_spawn
Kiểm soát hỗ trợ tệp đính kèm nội tuyến cho sessions_spawn.
Ghi chú về tệp đính kèm
Ghi chú về tệp đính kèm
- Tệp đính kèm chỉ được hỗ trợ cho
runtime: "subagent". Runtime ACP từ chối chúng. - Tệp được hiện thực hóa vào workspace con tại
.openclaw/attachments/<uuid>/cùng với một.manifest.json. - Nội dung tệp đính kèm tự động được biên tập khỏi phần lưu giữ bản ghi cuộc trao đổi.
- Đầu vào Base64 được xác thực bằng kiểm tra nghiêm ngặt bảng chữ cái/phần đệm và một cơ chế bảo vệ kích thước trước khi giải mã.
- Quyền tệp là
0700cho thư mục và0600cho tệp. - Việc dọn dẹp tuân theo chính sách
cleanup:deleteluôn xóa tệp đính kèm;keepchỉ giữ lại chúng khiretainOnSessionKeep: true.
tools.experimental
Cờ công cụ tích hợp thử nghiệm. Mặc định tắt trừ khi áp dụng quy tắc tự động bật GPT-5 strict-agentic.
planTool: bật công cụupdate_plancó cấu trúc để theo dõi công việc nhiều bước không tầm thường.- Mặc định:
falsetrừ khiagents.defaults.embeddedPi.executionContract(hoặc ghi đè theo từng tác nhân) được đặt thành"strict-agentic"cho một lượt chạy thuộc họ GPT-5 của OpenAI hoặc OpenAI Codex. Đặttrueđể buộc bật công cụ ngoài phạm vi đó, hoặcfalseđể giữ tắt ngay cả với các lượt chạy GPT-5 strict-agentic. - Khi được bật, prompt hệ thống cũng thêm hướng dẫn sử dụng để mô hình chỉ dùng nó cho công việc đáng kể và giữ tối đa một bước
in_progress.
agents.defaults.subagents
model: mô hình mặc định cho các tác nhân con được tạo. Nếu bỏ qua, tác nhân con kế thừa mô hình của bên gọi.allowAgents: danh sách cho phép mặc định gồm các ID tác nhân đích chosessions_spawnkhi tác nhân yêu cầu không đặtsubagents.allowAgentsriêng (["*"]= bất kỳ; mặc định: chỉ cùng tác nhân).runTimeoutSeconds: thời gian chờ mặc định (giây) chosessions_spawnkhi lời gọi công cụ bỏ quarunTimeoutSeconds.0nghĩa là không có thời gian chờ.announceTimeoutMs: thời gian chờ theo từng lời gọi (mili giây) cho các lần thử phân phối thông báoagentcủa Gateway. Mặc định:120000. Các lần thử lại tạm thời có thể khiến tổng thời gian chờ thông báo dài hơn một thời gian chờ đã cấu hình.- Chính sách công cụ theo từng tác nhân con:
tools.subagents.tools.allow/tools.subagents.tools.deny.
Nhà cung cấp tùy chỉnh và URL cơ sở
OpenClaw dùng danh mục mô hình tích hợp. Thêm nhà cung cấp tùy chỉnh quamodels.providers trong cấu hình hoặc ~/.openclaw/agents/<agentId>/agent/models.json.
Xác thực và thứ tự ưu tiên khi hợp nhất
Xác thực và thứ tự ưu tiên khi hợp nhất
- Dùng
authHeader: true+headerscho các nhu cầu xác thực tùy chỉnh. - Ghi đè gốc cấu hình tác nhân bằng
OPENCLAW_AGENT_DIR(hoặcPI_CODING_AGENT_DIR, một bí danh biến môi trường kế thừa). - Thứ tự ưu tiên hợp nhất cho các ID nhà cung cấp khớp nhau:
- Các giá trị
baseUrlkhông rỗng trongmodels.jsoncủa tác nhân được ưu tiên. - Các giá trị
apiKeykhông rỗng trong tác nhân chỉ được ưu tiên khi nhà cung cấp đó không do SecretRef quản lý trong ngữ cảnh cấu hình/hồ sơ xác thực hiện tại. - Các giá trị
apiKeycủa nhà cung cấp do SecretRef quản lý được làm mới từ dấu nguồn (ENV_VAR_NAMEcho tham chiếu env,secretref-managedcho tham chiếu file/exec) thay vì lưu giữ bí mật đã phân giải. - Các giá trị header của nhà cung cấp do SecretRef quản lý được làm mới từ dấu nguồn (
secretref-env:ENV_VAR_NAMEcho tham chiếu env,secretref-managedcho tham chiếu file/exec). apiKey/baseUrltrống hoặc thiếu trong tác nhân sẽ rơi vềmodels.providerstrong cấu hình.contextWindow/maxTokenscủa mô hình khớp dùng giá trị cao hơn giữa cấu hình tường minh và giá trị danh mục ngầm định.contextTokenscủa mô hình khớp giữ nguyên giới hạn runtime tường minh khi có; dùng nó để giới hạn ngữ cảnh hiệu dụng mà không thay đổi siêu dữ liệu mô hình gốc.- Dùng
models.mode: "replace"khi bạn muốn cấu hình viết lại hoàn toànmodels.json. - Việc lưu giữ dấu lấy nguồn làm thẩm quyền: dấu được ghi từ ảnh chụp cấu hình nguồn đang hoạt động (trước phân giải), không phải từ các giá trị bí mật runtime đã phân giải.
- Các giá trị
Chi tiết trường nhà cung cấp
Danh mục cấp cao nhất
Danh mục cấp cao nhất
models.mode: hành vi danh mục nhà cung cấp (mergehoặcreplace).models.providers: bản đồ nhà cung cấp tùy chỉnh được khóa theo ID nhà cung cấp.- Chỉnh sửa an toàn: dùng
openclaw config set models.providers.<id> '<json>' --strict-json --mergehoặcopenclaw config set models.providers.<id>.models '<json-array>' --strict-json --mergecho các bản cập nhật bổ sung.config settừ chối thay thế phá hủy trừ khi bạn truyền--replace.
- Chỉnh sửa an toàn: dùng
Kết nối và xác thực nhà cung cấp
Kết nối và xác thực nhà cung cấp
models.providers.*.api: bộ điều hợp yêu cầu (openai-completions,openai-responses,anthropic-messages,google-generative-ai, v.v.). Với các backend tự lưu trữ/v1/chat/completionsnhư MLX, vLLM, SGLang và hầu hết máy chủ cục bộ tương thích OpenAI, dùngopenai-completions. Một nhà cung cấp tùy chỉnh cóbaseUrlnhưng không cóapimặc định làopenai-completions; chỉ đặtopenai-responseskhi backend hỗ trợ/v1/responses.models.providers.*.apiKey: thông tin xác thực nhà cung cấp (ưu tiên SecretRef/thay thế env).models.providers.*.auth: chiến lược xác thực (api-key,token,oauth,aws-sdk).models.providers.*.contextWindow: cửa sổ ngữ cảnh gốc mặc định cho các mô hình thuộc nhà cung cấp này khi mục mô hình không đặtcontextWindow.models.providers.*.contextTokens: giới hạn ngữ cảnh runtime hiệu dụng mặc định cho các mô hình thuộc nhà cung cấp này khi mục mô hình không đặtcontextTokens.models.providers.*.maxTokens: giới hạn token đầu ra mặc định cho các mô hình thuộc nhà cung cấp này khi mục mô hình không đặtmaxTokens.models.providers.*.timeoutSeconds: thời gian chờ yêu cầu HTTP mô hình tùy chọn theo từng nhà cung cấp, tính bằng giây, bao gồm kết nối, header, body và xử lý hủy toàn bộ yêu cầu.models.providers.*.injectNumCtxForOpenAICompat: với Ollama +openai-completions, chènoptions.num_ctxvào yêu cầu (mặc định:true).models.providers.*.authHeader: buộc truyền thông tin xác thực trong headerAuthorizationkhi cần.models.providers.*.baseUrl: URL cơ sở API upstream.models.providers.*.headers: header tĩnh bổ sung cho định tuyến proxy/tenant.
Ghi đè truyền tải yêu cầu
Ghi đè truyền tải yêu cầu
models.providers.*.request: ghi đè truyền tải cho các yêu cầu HTTP tới nhà cung cấp mô hình.request.headers: header bổ sung (được hợp nhất với mặc định của nhà cung cấp). Giá trị chấp nhận SecretRef.request.auth: ghi đè chiến lược xác thực. Chế độ:"provider-default"(dùng xác thực tích hợp của nhà cung cấp),"authorization-bearer"(vớitoken),"header"(vớiheaderName,value,prefixtùy chọn).request.proxy: ghi đè proxy HTTP. Chế độ:"env-proxy"(dùng biến môi trườngHTTP_PROXY/HTTPS_PROXY),"explicit-proxy"(vớiurl). Cả hai chế độ đều chấp nhận một đối tượng contlstùy chọn.request.tls: ghi đè TLS cho kết nối trực tiếp. Trường:ca,cert,key,passphrase(tất cả chấp nhận SecretRef),serverName,insecureSkipVerify.request.allowPrivateNetwork: khitrue, cho phép HTTPS tớibaseUrlkhi DNS phân giải tới dải riêng tư, CGNAT hoặc tương tự, thông qua cơ chế bảo vệ fetch HTTP của nhà cung cấp (người vận hành chủ động chọn dùng cho các endpoint tương thích OpenAI tự lưu trữ đáng tin cậy). URL luồng nhà cung cấp mô hình local loopback nhưlocalhost,127.0.0.1và[::1]được tự động cho phép trừ khi giá trị này được đặt tường minh thànhfalse; các máy chủ LAN, tailnet và DNS riêng vẫn cần chủ động chọn dùng. WebSocket dùng cùngrequestcho header/TLS nhưng không dùng cổng SSRF fetch đó. Mặc địnhfalse.
Mục danh mục mô hình
Mục danh mục mô hình
models.providers.*.models: các mục danh mục mô hình tường minh của nhà cung cấp.models.providers.*.models.*.input: phương thức đầu vào của mô hình. Dùng["text"]cho mô hình chỉ văn bản và["text", "image"]cho mô hình hình ảnh/thị giác gốc. Tệp đính kèm hình ảnh chỉ được chèn vào lượt tác nhân khi mô hình đã chọn được đánh dấu có khả năng xử lý hình ảnh.models.providers.*.models.*.contextWindow: siêu dữ liệu cửa sổ ngữ cảnh gốc của mô hình. Trường này ghi đècontextWindowcấp nhà cung cấp cho mô hình đó.models.providers.*.models.*.contextTokens: giới hạn ngữ cảnh runtime tùy chọn. Trường này ghi đècontextTokenscấp nhà cung cấp; dùng khi bạn muốn ngân sách ngữ cảnh hiệu dụng nhỏ hơncontextWindowgốc của mô hình;openclaw models listhiển thị cả hai giá trị khi chúng khác nhau.models.providers.*.models.*.compat.supportsDeveloperRole: gợi ý tương thích tùy chọn. Vớiapi: "openai-completions"cóbaseUrlkhông rỗng và không phải gốc (host không phảiapi.openai.com), OpenClaw buộc giá trị này thànhfalseở runtime.baseUrltrống/bị bỏ qua giữ hành vi OpenAI mặc định.models.providers.*.models.*.compat.requiresStringContent: gợi ý tương thích tùy chọn cho các endpoint chat tương thích OpenAI chỉ nhận chuỗi. Khitrue, OpenClaw làm phẳng các mảngmessages[].contentthuần văn bản thành chuỗi đơn giản trước khi gửi yêu cầu.models.providers.*.models.*.compat.strictMessageKeys: gợi ý tương thích tùy chọn cho các endpoint chat tương thích OpenAI nghiêm ngặt. Khitrue, OpenClaw rút gọn các đối tượng tin nhắn Chat Completions gửi đi chỉ cònrolevàcontenttrước khi gửi yêu cầu.models.providers.*.models.*.compat.thinkingFormat: gợi ý payload suy nghĩ tùy chọn. Dùng"qwen"choenable_thinkingcấp cao nhất, hoặc"qwen-chat-template"chochat_template_kwargs.enable_thinkingtrên các máy chủ tương thích OpenAI thuộc họ Qwen có hỗ trợ kwargs chat-template cấp yêu cầu, như vLLM.
Khám phá Amazon Bedrock
Khám phá Amazon Bedrock
plugins.entries.amazon-bedrock.config.discovery: gốc cài đặt tự động khám phá Bedrock.plugins.entries.amazon-bedrock.config.discovery.enabled: bật/tắt khám phá ngầm định.plugins.entries.amazon-bedrock.config.discovery.region: vùng AWS để khám phá.plugins.entries.amazon-bedrock.config.discovery.providerFilter: bộ lọc ID nhà cung cấp tùy chọn cho khám phá có mục tiêu.plugins.entries.amazon-bedrock.config.discovery.refreshInterval: khoảng thăm dò để làm mới khám phá.plugins.entries.amazon-bedrock.config.discovery.defaultContextWindow: cửa sổ ngữ cảnh dự phòng cho các mô hình được khám phá.plugins.entries.amazon-bedrock.config.discovery.defaultMaxTokens: số token đầu ra tối đa dự phòng cho các mô hình được khám phá.
--custom-image-input để ép siêu dữ liệu có khả năng xử lý hình ảnh hoặc --custom-text-input để ép siêu dữ liệu chỉ hỗ trợ văn bản.
Ví dụ về nhà cung cấp
Cerebras (GLM 4.7 / GPT OSS)
Cerebras (GLM 4.7 / GPT OSS)
Plugin nhà cung cấp Dùng
cerebras đi kèm có thể cấu hình phần này qua openclaw onboard --auth-choice cerebras-api-key. Chỉ dùng cấu hình nhà cung cấp rõ ràng khi ghi đè mặc định.cerebras/zai-glm-4.7 cho Cerebras; zai/glm-4.7 cho Z.AI trực tiếp.Kimi Coding
Kimi Coding
openclaw onboard --auth-choice kimi-code-api-key.Local models (LM Studio)
Local models (LM Studio)
Xem Mô hình cục bộ. TL;DR: chạy mô hình cục bộ lớn qua LM Studio Responses API trên phần cứng mạnh; giữ các mô hình được lưu trữ ở chế độ hợp nhất để dự phòng.
MiniMax M2.7 (direct)
MiniMax M2.7 (direct)
MINIMAX_API_KEY. Lối tắt: openclaw onboard --auth-choice minimax-global-api hoặc openclaw onboard --auth-choice minimax-cn-api. Danh mục mô hình mặc định chỉ có M2.7. Trên đường dẫn phát trực tuyến tương thích với Anthropic, OpenClaw tắt chế độ suy nghĩ của MiniMax theo mặc định trừ khi bạn tự đặt rõ thinking. /fast on hoặc params.fastMode: true viết lại MiniMax-M2.7 thành MiniMax-M2.7-highspeed.Moonshot AI (Kimi)
Moonshot AI (Kimi)
baseUrl: "https://api.moonshot.cn/v1" hoặc openclaw onboard --auth-choice moonshot-api-key-cn.Các điểm cuối Moonshot gốc quảng bá khả năng tương thích thống kê mức sử dụng khi phát trực tuyến trên phương tiện truyền tải openai-completions dùng chung, và OpenClaw xác định điều đó dựa trên năng lực của điểm cuối thay vì chỉ dựa vào ID nhà cung cấp tích hợp sẵn.OpenCode
OpenCode
OPENCODE_API_KEY (hoặc OPENCODE_ZEN_API_KEY). Dùng tham chiếu opencode/... cho danh mục Zen hoặc tham chiếu opencode-go/... cho danh mục Go. Lối tắt: openclaw onboard --auth-choice opencode-zen hoặc openclaw onboard --auth-choice opencode-go.Synthetic (Anthropic-compatible)
Synthetic (Anthropic-compatible)
/v1 (máy khách Anthropic sẽ thêm phần này). Lối tắt: openclaw onboard --auth-choice synthetic-api-key.Z.AI (GLM-4.7)
Z.AI (GLM-4.7)
ZAI_API_KEY. z.ai/* và z-ai/* là các bí danh được chấp nhận. Lối tắt: openclaw onboard --auth-choice zai-api-key.- Điểm cuối chung:
https://api.z.ai/api/paas/v4 - Điểm cuối lập trình (mặc định):
https://api.z.ai/api/coding/paas/v4 - Đối với điểm cuối chung, định nghĩa nhà cung cấp tùy chỉnh với ghi đè URL cơ sở.
Liên quan
- Cấu hình — tác tử
- Cấu hình — kênh
- Tham chiếu cấu hình — các khóa cấp cao nhất khác
- Công cụ và plugin