Hướng dẫn này trình bày cách xây dựng một Plugin nhà cung cấp để thêm một nhà cung cấp mô hình (LLM) vào OpenClaw. Sau khi hoàn tất, bạn sẽ có một nhà cung cấp với danh mục mô hình, xác thực bằng khóa API và phân giải mô hình động.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.
Nếu bạn chưa từng xây dựng Plugin OpenClaw nào, trước tiên hãy đọc
Bắt đầu để nắm cấu trúc gói cơ bản
và cách thiết lập manifest.
Hướng dẫn từng bước
Package and manifest
Bước 1: Gói và manifest
providerAuthEnvVars để OpenClaw có thể phát hiện
thông tin xác thực mà không cần tải runtime Plugin của bạn. Thêm providerAuthAliases
khi một biến thể nhà cung cấp nên dùng lại xác thực của id nhà cung cấp khác. modelSupport
là tùy chọn và cho phép OpenClaw tự động tải Plugin nhà cung cấp của bạn từ các id
mô hình viết tắt như acme-large trước khi có hook runtime. Nếu bạn phát hành
nhà cung cấp trên ClawHub, các trường openclaw.compat và openclaw.build đó
là bắt buộc trong package.json.Register the provider
Một nhà cung cấp văn bản tối thiểu cần có
id, label, auth và catalog.
catalog là hook runtime/cấu hình do nhà cung cấp sở hữu; nó có thể gọi
API nhà cung cấp trực tiếp và trả về các mục models.providers.index.ts
registerModelCatalogProvider là bề mặt danh mục control-plane mới hơn
cho UI danh sách/trợ giúp/bộ chọn. Dùng nó cho các hàng văn bản, tạo hình ảnh,
tạo video và tạo nhạc. Giữ các lệnh gọi endpoint của nhà cung cấp và
ánh xạ phản hồi trong Plugin; OpenClaw sở hữu hình dạng hàng dùng chung, nhãn
nguồn và cách hiển thị trợ giúp.Đây là một nhà cung cấp hoạt động được. Người dùng giờ có thể
openclaw onboard --acme-ai-api-key <key> và chọn
acme-ai/acme-large làm mô hình của họ.Nếu nhà cung cấp thượng nguồn dùng token điều khiển khác với OpenClaw, hãy thêm một
phép biến đổi văn bản hai chiều nhỏ thay vì thay thế đường dẫn stream:input viết lại prompt hệ thống cuối cùng và nội dung tin nhắn văn bản trước
khi vận chuyển. output viết lại các delta văn bản của trợ lý và văn bản cuối cùng trước khi
OpenClaw phân tích marker điều khiển riêng hoặc gửi qua kênh.Với các nhà cung cấp được đóng gói sẵn chỉ đăng ký một nhà cung cấp văn bản với xác thực
khóa API cộng với một runtime duy nhất dựa trên danh mục, hãy ưu tiên helper hẹp hơn
defineSingleProviderPluginEntry(...):buildProvider là đường dẫn danh mục trực tiếp được dùng khi OpenClaw có thể phân giải
xác thực nhà cung cấp thật. Nó có thể thực hiện khám phá riêng cho nhà cung cấp. Chỉ dùng
buildStaticProvider cho các hàng ngoại tuyến an toàn để hiển thị trước khi cấu hình xác thực;
nó không được yêu cầu thông tin xác thực hoặc tạo yêu cầu mạng.
Hiển thị models list --all của OpenClaw hiện chỉ thực thi danh mục tĩnh
cho các Plugin nhà cung cấp được đóng gói sẵn, với cấu hình rỗng, env rỗng và không có
đường dẫn agent/workspace.Nếu luồng xác thực của bạn cũng cần vá models.providers.*, bí danh và
mô hình mặc định của agent trong quá trình onboarding, hãy dùng các helper preset từ
openclaw/plugin-sdk/provider-onboard. Các helper hẹp nhất là
createDefaultModelPresetAppliers(...),
createDefaultModelsPresetAppliers(...) và
createModelCatalogPresetAppliers(...).Khi endpoint native của một nhà cung cấp hỗ trợ các khối usage được stream trên
transport openai-completions thông thường, hãy ưu tiên các helper danh mục dùng chung trong
openclaw/plugin-sdk/provider-catalog-shared thay vì mã hóa cứng
các kiểm tra provider-id. supportsNativeStreamingUsageCompat(...) và
applyProviderNativeStreamingUsageCompat(...) phát hiện hỗ trợ từ
bản đồ capability của endpoint, nên các endpoint native kiểu Moonshot/DashScope vẫn
có thể tự chọn tham gia ngay cả khi một Plugin đang dùng id nhà cung cấp tùy chỉnh.Add dynamic model resolution
Nếu nhà cung cấp của bạn chấp nhận ID mô hình tùy ý (như proxy hoặc router),
hãy thêm Nếu việc phân giải yêu cầu lệnh gọi mạng, hãy dùng
resolveDynamicModel:prepareDynamicModel để khởi động
bất đồng bộ - resolveDynamicModel sẽ chạy lại sau khi hoàn tất.Add runtime hooks (as needed)
Hầu hết nhà cung cấp chỉ cần Các nhóm replay hiện có hôm nay:
Các họ stream hiện có hôm nay:
catalog + resolveDynamicModel. Thêm hook
dần dần khi nhà cung cấp của bạn cần đến.Các builder helper dùng chung hiện bao phủ những nhóm replay/tool-compat
phổ biến nhất, nên Plugin thường không cần tự nối từng hook một:| Họ | Nội dung được kết nối | Ví dụ đi kèm |
|---|---|---|
openai-compatible | Chính sách phát lại kiểu OpenAI dùng chung cho các transport tương thích OpenAI, bao gồm làm sạch tool-call-id, sửa thứ tự assistant-trước, và xác thực lượt Gemini chung khi transport cần | moonshot, ollama, xai, zai |
anthropic-by-model | Chính sách phát lại có nhận biết Claude được chọn theo modelId, để các transport thông điệp Anthropic chỉ nhận dọn dẹp thinking-block riêng cho Claude khi mô hình đã phân giải thực sự là một id Claude | amazon-bedrock, anthropic-vertex |
google-gemini | Chính sách phát lại Gemini gốc, cùng làm sạch phát lại bootstrap và chế độ reasoning-output có gắn thẻ | google, google-gemini-cli |
passthrough-gemini | Làm sạch chữ ký suy nghĩ Gemini cho các mô hình Gemini chạy qua transport proxy tương thích OpenAI; không bật xác thực phát lại Gemini gốc hoặc ghi lại bootstrap | openrouter, kilocode, opencode, opencode-go |
hybrid-anthropic-openai | Chính sách lai cho các nhà cung cấp kết hợp bề mặt mô hình thông điệp Anthropic và tương thích OpenAI trong một Plugin; việc bỏ thinking-block chỉ dành cho Claude tùy chọn vẫn được giới hạn ở phía Anthropic | minimax |
| Họ | Nội dung được kết nối | Ví dụ đi kèm |
|---|---|---|
google-thinking | Chuẩn hóa payload suy nghĩ Gemini trên đường dẫn stream dùng chung | google, google-gemini-cli |
kilocode-thinking | Wrapper suy luận Kilo trên đường dẫn stream proxy dùng chung, với kilo/auto và các id suy luận proxy không được hỗ trợ bỏ qua phần suy nghĩ được chèn | kilocode |
moonshot-thinking | Ánh xạ payload native-thinking nhị phân của Moonshot từ cấu hình + mức /think | moonshot |
minimax-fast-mode | Ghi lại mô hình chế độ nhanh MiniMax trên đường dẫn stream dùng chung | minimax, minimax-portal |
openai-responses-defaults | Các wrapper OpenAI/Codex Responses gốc dùng chung: header ghi nhận nguồn, /fast/serviceTier, độ dài văn bản, tìm kiếm web Codex gốc, định dạng payload tương thích suy luận, và quản lý ngữ cảnh Responses | openai, openai-codex |
openrouter-thinking | Wrapper suy luận OpenRouter cho các tuyến proxy, với việc bỏ qua mô hình không được hỗ trợ/auto được xử lý tập trung | openrouter |
tool-stream-default-on | Wrapper tool_stream bật mặc định cho các nhà cung cấp như Z.AI muốn stream công cụ trừ khi bị tắt rõ ràng | zai |
SDK seams powering the family builders
SDK seams powering the family builders
Mỗi trình dựng họ được kết hợp từ các helper công khai cấp thấp hơn được xuất từ cùng gói, bạn có thể dùng khi một nhà cung cấp cần đi lệch khỏi mẫu chung:
openclaw/plugin-sdk/provider-model-shared-ProviderReplayFamily,buildProviderReplayFamilyHooks(...), và các trình dựng phát lại thô (buildOpenAICompatibleReplayPolicy,buildAnthropicReplayPolicyForModel,buildGoogleGeminiReplayPolicy,buildHybridAnthropicOrOpenAIReplayPolicy). Cũng xuất các helper phát lại Gemini (sanitizeGoogleGeminiReplayHistory,resolveTaggedReasoningOutputMode) và helper endpoint/mô hình (resolveProviderEndpoint,normalizeProviderId,normalizeGooglePreviewModelId).openclaw/plugin-sdk/provider-stream-ProviderStreamFamily,buildProviderStreamFamilyHooks(...),composeProviderStreamWrappers(...), cộng với các wrapper OpenAI/Codex dùng chung (createOpenAIAttributionHeadersWrapper,createOpenAIFastModeWrapper,createOpenAIServiceTierWrapper,createOpenAIResponsesContextManagementWrapper,createCodexNativeWebSearchWrapper), wrapper tương thích OpenAI DeepSeek V4 (createDeepSeekV4OpenAICompatibleThinkingWrapper), dọn dẹp prefill suy nghĩ Anthropic Messages (createAnthropicThinkingPrefillPayloadWrapper), và các wrapper proxy/nhà cung cấp dùng chung (createOpenRouterWrapper,createToolStreamWrapper,createMinimaxFastModeWrapper).openclaw/plugin-sdk/provider-tools-ProviderToolCompatFamily,buildProviderToolCompatFamilyHooks("gemini"), và các helper schema Gemini bên dưới (normalizeGeminiToolSchemas,inspectGeminiToolSchemas).
@openclaw/anthropic-provider giữ wrapAnthropicProviderStream, resolveAnthropicBetas, resolveAnthropicFastMode, resolveAnthropicServiceTier, và các trình dựng wrapper Anthropic cấp thấp hơn trong seam công khai api.ts / contract-api.ts của chính nó vì chúng mã hóa xử lý beta OAuth Claude và gating context1m. Plugin xAI cũng tương tự, giữ định dạng Responses xAI gốc trong wrapStreamFn của chính nó (bí danh /fast, tool_stream mặc định, dọn dẹp strict-tool không được hỗ trợ, loại bỏ payload suy luận riêng của xAI).Mẫu package-root tương tự cũng hỗ trợ @openclaw/openai-provider (trình dựng nhà cung cấp, helper mô hình mặc định, trình dựng nhà cung cấp realtime) và @openclaw/openrouter-provider (trình dựng nhà cung cấp cùng helper onboarding/cấu hình).- Token exchange
- Custom headers
- Native transport identity
- Usage and billing
Đối với các nhà cung cấp cần trao đổi token trước mỗi lệnh gọi suy luận:
All available provider hooks
All available provider hooks
OpenClaw gọi hook theo thứ tự này. Hầu hết nhà cung cấp chỉ dùng 2-3:
Các trường nhà cung cấp chỉ dành cho tương thích mà OpenClaw không còn gọi, chẳng hạn như
Ghi chú dự phòng runtime:
ProviderPlugin.capabilities và suppressBuiltInModel, không được liệt kê
ở đây.| # | Hook | Khi nào dùng |
|---|---|---|
| 1 | catalog | Danh mục mô hình hoặc mặc định URL cơ sở |
| 2 | applyConfigDefaults | Mặc định toàn cục do nhà cung cấp sở hữu trong quá trình vật chất hóa cấu hình |
| 3 | normalizeModelId | Dọn dẹp bí danh model-id legacy/preview trước khi tra cứu |
| 4 | normalizeTransport | Dọn dẹp api / baseUrl của họ nhà cung cấp trước khi lắp ráp mô hình chung |
| 5 | normalizeConfig | Chuẩn hóa cấu hình models.providers.<id> |
| 6 | applyNativeStreamingUsageCompat | Ghi lại tương thích streaming-usage gốc cho nhà cung cấp cấu hình |
| 7 | resolveConfigApiKey | Phân giải xác thực env-marker do nhà cung cấp sở hữu |
| 8 | resolveSyntheticAuth | Xác thực tổng hợp cục bộ/tự lưu trữ hoặc dựa trên cấu hình |
| 9 | shouldDeferSyntheticProfileAuth | Hạ ưu tiên placeholder hồ sơ được lưu tổng hợp phía sau xác thực env/cấu hình |
| 10 | resolveDynamicModel | Chấp nhận id mô hình upstream tùy ý |
| 11 | prepareDynamicModel | Lấy metadata bất đồng bộ trước khi phân giải |
| 12 | normalizeResolvedModel | Ghi lại transport trước runner |
| 13 | contributeResolvedModelCompat | Cờ tương thích cho mô hình vendor phía sau một transport tương thích khác |
| 14 | normalizeToolSchemas | Dọn dẹp tool-schema do nhà cung cấp sở hữu trước khi đăng ký |
| 15 | inspectToolSchemas | Chẩn đoán tool-schema do nhà cung cấp sở hữu |
| 16 | resolveReasoningOutputMode | Hợp đồng reasoning-output có gắn thẻ so với gốc |
| 17 | prepareExtraParams | Tham số yêu cầu mặc định |
| 18 | createStreamFn | Transport StreamFn hoàn toàn tùy chỉnh |
| 19 | wrapStreamFn | Wrapper header/body tùy chỉnh trên đường dẫn stream bình thường |
| 20 | resolveTransportTurnState | Header/metadata gốc theo từng lượt |
| 21 | resolveWebSocketSessionPolicy | Header/cool-down phiên WS gốc |
| 22 | formatApiKey | Dạng token runtime tùy chỉnh |
| 23 | refreshOAuth | Làm mới OAuth tùy chỉnh |
| 24 | buildAuthDoctorHint | Hướng dẫn sửa xác thực |
| 25 | matchesContextOverflowError | Phát hiện tràn do nhà cung cấp sở hữu |
| 26 | classifyFailoverReason | Phân loại rate-limit/quá tải do nhà cung cấp sở hữu |
| 27 | isCacheTtlEligible | Gating TTL bộ nhớ đệm prompt |
| 28 | buildMissingAuthMessage | Gợi ý thiếu xác thực tùy chỉnh |
| 29 | augmentModelCatalog | Hàng forward-compat tổng hợp |
| 30 | resolveThinkingProfile | Bộ tùy chọn /think riêng theo mô hình |
| 31 | isBinaryThinking | Tương thích bật/tắt suy nghĩ nhị phân |
| 32 | supportsXHighThinking | Tương thích hỗ trợ suy luận xhigh |
| 33 | resolveDefaultThinkingLevel | Tương thích chính sách /think mặc định |
| 34 | isModernModelRef | Khớp mô hình live/smoke |
| 35 | prepareRuntimeAuth | Trao đổi token trước suy luận |
| 36 | resolveUsageAuth | Phân tích thông tin xác thực sử dụng tùy chỉnh |
| 37 | fetchUsageSnapshot | Endpoint sử dụng tùy chỉnh |
| 38 | createEmbeddingProvider | Adapter embedding do nhà cung cấp sở hữu cho memory/search |
| 39 | buildReplayPolicy | Chính sách phát lại/Compaction transcript tùy chỉnh |
| 40 | sanitizeReplayHistory | Ghi lại phát lại riêng theo nhà cung cấp sau dọn dẹp chung |
| 41 | validateReplayTurns | Xác thực nghiêm ngặt lượt phát lại trước runner nhúng |
| 42 | onModelSelected | Callback sau khi chọn (ví dụ: telemetry) |
normalizeConfigkiểm tra nhà cung cấp đã khớp trước, sau đó đến các Plugin nhà cung cấp có hook khác cho đến khi một hook thực sự thay đổi cấu hình. Nếu không có hook nhà cung cấp nào ghi lại một mục cấu hình họ Google được hỗ trợ, trình chuẩn hóa cấu hình Google đi kèm vẫn được áp dụng.resolveConfigApiKeydùng hook nhà cung cấp khi được hiển thị. Đường dẫnamazon-bedrockđi kèm cũng có resolver env-marker AWS tích hợp sẵn ở đây, dù bản thân xác thực runtime Bedrock vẫn dùng chuỗi mặc định AWS SDK.resolveSystemPromptContributioncho phép một nhà cung cấp chèn hướng dẫn system-prompt có nhận biết bộ nhớ đệm cho một họ mô hình. Ưu tiên dùng nó thay vìbefore_prompt_buildkhi hành vi thuộc về một nhà cung cấp/họ mô hình và cần giữ phân tách bộ nhớ đệm ổn định/động.
Add extra capabilities (optional)
Bước 5: Thêm khả năng bổ sung
Một Plugin nhà cung cấp có thể đăng ký giọng nói, phiên âm realtime, thoại realtime, hiểu nội dung phương tiện, tạo ảnh, tạo video, web fetch, và web search cùng với suy luận văn bản. OpenClaw phân loại đây là một Plugin năng lực lai - mẫu được khuyến nghị cho Plugin của công ty (một Plugin cho mỗi nhà cung cấp). Xem Nội bộ: Quyền sở hữu năng lực.Đăng ký từng năng lực bên trongregister(api) cùng với lệnh gọi
api.registerProvider(...) hiện có của bạn. Chỉ chọn các tab bạn cần:- Speech (TTS)
- Realtime transcription
- Realtime voice
- Media understanding
- Image and video generation
- Web fetch and search
assertOkOrThrowProviderError(...) cho lỗi HTTP của nhà cung cấp để
các Plugin dùng chung cơ chế đọc phần thân lỗi có giới hạn, phân tích lỗi JSON và
hậu tố request-id.Test
Bước 6: Kiểm thử
src/provider.test.ts
Xuất bản lên ClawHub
Plugin nhà cung cấp được xuất bản giống như mọi Plugin mã ngoài khác:clawhub package publish.
Cấu trúc tệp
Tham chiếu thứ tự catalog
catalog.order kiểm soát thời điểm catalog của bạn được hợp nhất tương đối với
các nhà cung cấp tích hợp sẵn:
| Thứ tự | Khi nào | Trường hợp sử dụng |
|---|---|---|
simple | Lượt đầu | Nhà cung cấp dùng khóa API đơn giản |
profile | Sau simple | Nhà cung cấp bị chặn bởi hồ sơ xác thực |
paired | Sau profile | Tổng hợp nhiều mục liên quan |
late | Lượt cuối | Ghi đè nhà cung cấp hiện có (thắng khi xung đột) |
Các bước tiếp theo
- Plugin kênh - nếu Plugin của bạn cũng cung cấp một kênh
- SDK Runtime - helper
api.runtime(TTS, tìm kiếm, subagent) - Tổng quan SDK - tham chiếu import subpath đầy đủ
- Nội bộ Plugin - chi tiết hook và ví dụ tích hợp sẵn