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 | كل الأدوات المضمّنة (تستثني Plugins المزوّدين) |
tools.allow / tools.deny
سياسة السماح/الرفض العامة للأدوات (الرفض له الأولوية). غير حساسة لحالة الأحرف، وتدعم أحرف البدل *. تُطبّق حتى عندما يكون صندوق عزل Docker متوقفًا.
write وapply_patch معرّفا أداتين منفصلان. يفعّل allow: ["write"] أيضًا apply_patch للنماذج المتوافقة، لكن deny: ["write"] لا يرفض apply_patch. لحظر كل تعديل للملفات، ارفض group:fs أو اذكر كل أداة مُعدِّلة صراحةً:
tools.byProvider
يقيّد الأدوات أكثر لمزوّدين أو نماذج محددة. الترتيب: ملف التعريف الأساسي ← ملف تعريف المزوّد ← السماح/الرفض.
tools.toolsBySender
يقيّد الأدوات لهوية طالب محددة. هذا دفاع متعدد الطبقات فوق التحكم في وصول القناة؛ يجب أن تأتي قيم المرسل من محوّل القناة، لا من نص الرسالة.
channel:<channelId>:<senderId> أو id:<senderId> أو e164:<phone> أو username:<handle> أو name:<displayName> أو "*". معرّفات القنوات هي معرّفات OpenClaw القياسية؛ تُطبَّع الأسماء البديلة مثل teams إلى msteams. تُقبل المفاتيح القديمة بلا بادئة كـ id: فقط. ترتيب المطابقة هو القناة+المعرّف، ثم المعرّف، ثم e164، ثم اسم المستخدم، ثم الاسم، ثم حرف البدل.
يتجاوز agents.list[].tools.toolsBySender الخاص بكل وكيل مطابقة المرسل العامة عند مطابقته، حتى مع سياسة فارغة {}.
tools.elevated
يتحكم في وصول exec المرتفع خارج صندوق العزل:
- لا يمكن للتجاوز الخاص بكل وكيل (
agents.list[].tools.elevated) إلا أن يقيّد أكثر. - يخزّن
/elevated on|off|ask|fullالحالة لكل جلسة؛ وتُطبّق التوجيهات المضمنة على رسالة واحدة. - يتجاوز
execالمرتفع العزل ويستخدم مسار الخروج المضبوط (gatewayافتراضيًا، أوnodeعندما يكون هدف التنفيذ هوnode).
tools.exec
tools.loopDetection
Tool-loop safety checks معطّلة افتراضيًا. اضبط 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 (openai،anthropic،google/gemini،groq، إلخ)model: تجاوز معرّف النموذج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 (الجلسة الحالية + الجلسات التي أنشأتها، مثل الوكلاء الفرعيين).
Visibility scopes
Visibility scopes
self: مفتاح الجلسة الحالية فقط.tree: الجلسة الحالية + الجلسات التي أنشأتها الجلسة الحالية (الوكلاء الفرعيون).agent: أي جلسة تنتمي إلى معرّف الوكيل الحالي (يمكن أن تشمل مستخدمين آخرين إذا شغّلت جلسات لكل مرسل تحت معرّف الوكيل نفسه).all: أي جلسة. لا يزال الاستهداف عبر الوكلاء يتطلبtools.agentToAgent.- تقييد صندوق العزل: عندما تكون الجلسة الحالية معزولة ويكون
agents.defaults.sandbox.sessionToolsVisibility="spawned"، تُفرض الرؤية علىtreeحتى إذا كانtools.sessions.visibility="all".
tools.sessions_spawn
يتحكم في دعم المرفقات المضمنة لـ sessions_spawn.
Attachment notes
Attachment notes
- لا تُدعم المرفقات إلا مع
runtime: "subagent". يرفضها وقت تشغيل ACP. - تُحوَّل الملفات إلى ملفات فعلية داخل مساحة عمل الابن في
.openclaw/attachments/<uuid>/مع ملف.manifest.json. - يُحجب محتوى المرفقات تلقائيًا من استمرارية النصوص المنسوخة.
- تُتحقق مُدخلات Base64 بفحوصات صارمة للأبجدية/الحشو وحارس حجم قبل فك الترميز.
- أذونات الملفات هي
0700للأدلة و0600للملفات. - يتبع التنظيف سياسة
cleanup: يزيلdeleteالمرفقات دائمًا؛ ويُبقيهاkeepفقط عند ضبطretainOnSessionKeep: true.
tools.experimental
أعلام الأدوات المضمّنة التجريبية. تكون متوقفة افتراضيًا ما لم تنطبق قاعدة تفعيل تلقائي صارمة-وكيلية لـ GPT-5.
planTool: يفعّل أداةupdate_planالمهيكلة لتتبّع الأعمال متعددة الخطوات غير البسيطة.- الافتراضي:
falseما لم يتم ضبطagents.defaults.embeddedPi.executionContract(أو تجاوز لكل وكيل) على"strict-agentic"لتشغيل من عائلة OpenAI أو OpenAI Codex GPT-5. اضبطه علىtrueلفرض تشغيل الأداة خارج ذلك النطاق، أوfalseلإبقائها متوقفة حتى في تشغيلات GPT-5 صارمة-وكيلية. - عند تفعيلها، تضيف مطالبة النظام أيضًا إرشادات استخدام كي لا يستخدمها النموذج إلا للأعمال الكبيرة، مع إبقاء خطوة واحدة على الأكثر بحالة
in_progress.
agents.defaults.subagents
model: النموذج الافتراضي للوكلاء الفرعيين المُنشئين. إذا حُذف، يرث الوكلاء الفرعيون نموذج المستدعي.allowAgents: قائمة السماح الافتراضية لمعرّفات الوكلاء الهدف لـsessions_spawnعندما لا يضبط الوكيل الطالبsubagents.allowAgentsالخاص به (["*"]= أي وكيل؛ الافتراضي: الوكيل نفسه فقط).runTimeoutSeconds: المهلة الافتراضية (بالثواني) لـsessions_spawnعندما يحذف استدعاء الأداةrunTimeoutSeconds. تعني0عدم وجود مهلة.announceTimeoutMs: مهلة لكل استدعاء (بالمللي ثانية) لمحاولات تسليم إعلانagentعبر Gateway. الافتراضي:120000. قد تجعل إعادة المحاولة المؤقتة إجمالي انتظار الإعلان أطول من مهلة واحدة مكوّنة.- سياسة أدوات لكل وكيل فرعي:
tools.subagents.tools.allow/tools.subagents.tools.deny.
المزوّدون المخصصون وعناوين URL الأساسية
يستخدم OpenClaw كتالوج النماذج المضمّن. أضف مزوّدين مخصصين عبرmodels.providers في الإعدادات أو ~/.openclaw/agents/<agentId>/agent/models.json.
Auth and merge precedence
Auth and merge precedence
- استخدم
authHeader: true+headersلاحتياجات المصادقة المخصصة. - تجاوز جذر إعدادات الوكيل باستخدام
OPENCLAW_AGENT_DIR(أوPI_CODING_AGENT_DIR، وهو اسم مستعار قديم لمتغير بيئة). - أسبقية الدمج لمعرّفات المزوّدين المتطابقة:
- قيم
baseUrlغير الفارغة فيmodels.jsonالخاصة بالوكيل هي التي تفوز. - قيم
apiKeyغير الفارغة في الوكيل تفوز فقط عندما لا يكون ذلك المزوّد مُدارًا بواسطة SecretRef في سياق الإعدادات/ملف تعريف المصادقة الحالي. - تُحدَّث قيم
apiKeyللمزوّد المُدار بواسطة SecretRef من علامات المصدر (ENV_VAR_NAMEلمراجع env، وsecretref-managedلمراجع file/exec) بدلًا من الاستمرار في تخزين الأسرار المحلولة. - تُحدَّث قيم ترويسة المزوّد المُدار بواسطة SecretRef من علامات المصدر (
secretref-env:ENV_VAR_NAMEلمراجع env، وsecretref-managedلمراجع file/exec). - تعود قيم
apiKey/baseUrlالفارغة أو المفقودة في الوكيل إلىmodels.providersفي الإعدادات. - تستخدم
contextWindow/maxTokensللنموذج المتطابق القيمة الأعلى بين الإعدادات الصريحة وقيم الكتالوج الضمنية. - تحفظ
contextTokensللنموذج المتطابق حدًا صريحًا لوقت التشغيل عند وجوده؛ استخدمه للحد من السياق الفعّال دون تغيير بيانات النموذج الأصلية. - استخدم
models.mode: "replace"عندما تريد أن تعيد الإعدادات كتابةmodels.jsonبالكامل. - استمرارية العلامات موثوقة المصدر: تُكتب العلامات من لقطة إعدادات المصدر النشطة (قبل الحل)، وليس من قيم أسرار وقت التشغيل المحلولة.
- قيم
تفاصيل حقول المزوّد
Top-level catalog
Top-level catalog
models.mode: سلوك كتالوج المزوّدين (mergeأوreplace).models.providers: خريطة المزوّدين المخصصين، مفهرسة حسب معرّف المزوّد.- تعديلات آمنة: استخدم
openclaw config set models.providers.<id> '<json>' --strict-json --mergeأوopenclaw config set models.providers.<id>.models '<json-array>' --strict-json --mergeللتحديثات الإضافية. يرفضconfig setالاستبدالات المدمّرة ما لم تمرر--replace.
- تعديلات آمنة: استخدم
Provider connection and auth
Provider connection and auth
models.providers.*.api: محوّل الطلبات (openai-completions،openai-responses،anthropic-messages،google-generative-ai، إلخ). للخلفيات ذاتية الاستضافة/v1/chat/completionsمثل MLX وvLLM وSGLang ومعظم الخوادم المحلية المتوافقة مع OpenAI، استخدمopenai-completions. مزوّد مخصص لديهbaseUrlدونapiيستخدم افتراضيًاopenai-completions؛ اضبطopenai-responsesفقط عندما تدعم الخلفية/v1/responses.models.providers.*.apiKey: بيانات اعتماد المزوّد (يفضّل استبدال SecretRef/env).models.providers.*.auth: استراتيجية المصادقة (api-key،token،oauth،aws-sdk).models.providers.*.contextWindow: نافذة السياق الأصلية الافتراضية للنماذج تحت هذا المزوّد عندما لا يضبط إدخال النموذجcontextWindow.models.providers.*.contextTokens: الحد الفعّال الافتراضي لسياق وقت التشغيل للنماذج تحت هذا المزوّد عندما لا يضبط إدخال النموذجcontextTokens.models.providers.*.maxTokens: الحد الافتراضي لرموز الإخراج للنماذج تحت هذا المزوّد عندما لا يضبط إدخال النموذجmaxTokens.models.providers.*.timeoutSeconds: مهلة طلب HTTP اختيارية لكل مزوّد نموذج بالثواني، تشمل الاتصال والترويسات والمتن ومعالجة إجهاض الطلب بالكامل.models.providers.*.injectNumCtxForOpenAICompat: مع Ollama +openai-completions، يحقنoptions.num_ctxفي الطلبات (الافتراضي:true).models.providers.*.authHeader: يفرض نقل بيانات الاعتماد في ترويسةAuthorizationعند الحاجة.models.providers.*.baseUrl: عنوان URL الأساسي لواجهة API العلوية.models.providers.*.headers: ترويسات ثابتة إضافية لتوجيه الوكيل/المستأجر.
Request transport overrides
Request transport overrides
models.providers.*.request: تجاوزات النقل لطلبات HTTP الخاصة بمزوّد النموذج.request.headers: ترويسات إضافية (مدمجة مع افتراضيات المزوّد). تقبل القيم SecretRef.request.auth: تجاوز استراتيجية المصادقة. الأوضاع:"provider-default"(استخدم المصادقة المضمّنة للمزوّد)،"authorization-bearer"(معtoken)،"header"(معheaderNameوvalueوprefixاختياري).request.proxy: تجاوز وكيل HTTP. الأوضاع:"env-proxy"(استخدم متغيرات البيئةHTTP_PROXY/HTTPS_PROXY)،"explicit-proxy"(معurl). يقبل كلا الوضعين كائنًا فرعيًا اختياريًاtls.request.tls: تجاوز TLS للاتصالات المباشرة. الحقول:caوcertوkeyوpassphrase(كلها تقبل SecretRef)، وserverNameوinsecureSkipVerify.request.allowPrivateNetwork: عندtrue، يسمح بـ HTTPS إلىbaseUrlعندما يحل DNS إلى نطاقات خاصة أو CGNAT أو نطاقات مشابهة، عبر حارس جلب HTTP للمزوّد (اشتراك صريح من المشغّل لنقاط نهاية متوافقة مع OpenAI وذاتية الاستضافة وموثوقة). يُسمح تلقائيًا بعناوين URL الخاصة بتدفق مزوّد النموذج عبر local loopback مثلlocalhostو127.0.0.1و[::1]ما لم يُضبط هذا صراحة علىfalse؛ ولا تزال مضيفات LAN وtailnet وDNS الخاصة تتطلب اشتراكًا صريحًا. يستخدم WebSocket نفسrequestللترويسات/TLS لكن لا يستخدم بوابة SSRF لجلب HTTP تلك. الافتراضيfalse.
Model catalog entries
Model catalog entries
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النصية الخالصة إلى سلاسل عادية قبل إرسال الطلب.models.providers.*.models.*.compat.strictMessageKeys: تلميح توافق اختياري لنقاط نهاية الدردشة المتوافقة مع OpenAI الصارمة. عندtrue، يجرّد OpenClaw كائنات رسائل Chat Completions الصادرة إلىroleوcontentقبل إرسال الطلب.models.providers.*.models.*.compat.thinkingFormat: تلميح اختياري لحمولة التفكير. استخدم"qwen"لـenable_thinkingعلى المستوى الأعلى، أو"qwen-chat-template"لـchat_template_kwargs.enable_thinkingعلى خوادم عائلة Qwen المتوافقة مع OpenAI والتي تدعم kwargs لقالب الدردشة على مستوى الطلب، مثل vLLM.
Amazon Bedrock discovery
Amazon Bedrock discovery
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: مرشح اختياري لمعرّف المزوّد من أجل الاكتشاف المستهدف.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)
يمكن لـPlugin المزوّد المضمّن استخدم
cerebras تهيئة ذلك عبر openclaw onboard --auth-choice cerebras-api-key. استخدم إعدادات المزوّد الصريحة فقط عند تجاوز القيم الافتراضية.cerebras/zai-glm-4.7 لـCerebras؛ وzai/glm-4.7 لاتصال Z.AI المباشر.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، يعطّل OpenClaw التفكير في MiniMax افتراضيًا ما لم تضبط thinking صراحة بنفسك. يعيد /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 ذلك بقدرات نقطة النهاية بدلًا من معرّف المزوّد المدمج وحده.OpenCode
OpenCode
OPENCODE_API_KEY (أو OPENCODE_ZEN_API_KEY). استخدم مراجع opencode/... لكتالوج Zen أو مراجع opencode-go/... لكتالوج 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 الأساسي.
ذو صلة
- الإعدادات — الوكلاء
- الإعدادات — القنوات
- مرجع الإعدادات — مفاتيح المستوى الأعلى الأخرى
- الأدوات وPlugins