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. Đến cuối hướng dẫn, bạn sẽ có một nhà cung cấp với catalog 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://docs.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 đây, hãy đọc
Bắt đầu trước để nắm cấu trúc package
cơ bản và cách thiết lập manifest.
Hướng dẫn từng bước
Package 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 cần tái sử dụng 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 dạng viết tắt như acme-large trước khi các hook runtime tồn tại. 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.Đăng ký nhà cung cấp
Một nhà cung cấp tối thiểu cần có Đó là một nhà cung cấp hoạt động được. Giờ đây người dùng có thể
id, label, auth, và catalog:index.ts
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 upstream dùng các 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 ghi lại prompt hệ thống cuối cùng và nội dung tin nhắn văn bản trước khi
truyền tải. output ghi lại các delta văn bản của assistant và văn bản cuối cùng trước khi
OpenClaw phân tích các marker điều khiển riêng hoặc phân phối kênh.Với các nhà cung cấp đi kèm chỉ đăng ký một nhà cung cấp văn bản với xác thực bằng khóa API
cộng thêm một runtime duy nhất dựa trên catalog, hãy ưu tiên helper hẹp hơn
defineSingleProviderPluginEntry(...):buildProvider là đường dẫn catalog 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 phát hiện riêng theo 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 xác thực
được cấu hình; nó không được yêu cầu thông tin xác thực hoặc gửi yêu cầu mạng.
Hiện tại màn hình models list --all của OpenClaw chỉ thực thi catalog tĩnh
cho các Plugin nhà cung cấp đi kèm, 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.*, alias, 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 catalog dùng chung trong
openclaw/plugin-sdk/provider-catalog-shared thay vì hardcode
kiểm tra id nhà cung cấp. supportsNativeStreamingUsageCompat(...) và
applyProviderNativeStreamingUsageCompat(...) phát hiện hỗ trợ từ
bản đồ năng lực endpoint, nên các endpoint native kiểu Moonshot/DashScope vẫn
opt in ngay cả khi một Plugin đang dùng id nhà cung cấp tùy chỉnh.Thêm phân giải mô hình động
Nếu nhà cung cấp của bạn chấp nhận các ID mô hình tùy ý (như proxy hoặc router),
hãy thêm Nếu việc phân giải cần một yêu cầu mạng, hãy dùng
resolveDynamicModel:prepareDynamicModel để khởi động
bất đồng bộ — resolveDynamicModel sẽ chạy lại sau khi nó hoàn tất.Thêm hook runtime (khi cần)
Hầu hết nhà cung cấp chỉ cần Các nhóm replay hiện có:
Các nhóm stream hiện có:
catalog + resolveDynamicModel. Thêm hook
dần dần theo nhu cầu của nhà cung cấp của bạn.Các helper builder dùng chung hiện bao phủ những nhóm replay/tương thích công cụ
phổ biến nhất, nên Plugin thường không cần tự nối từng hook một:| Nhóm | Nội dung được nối vào | Ví dụ đi kèm |
|---|---|---|
openai-compatible | Chính sách replay kiểu OpenAI dùng chung cho các transport tương thích OpenAI, bao gồm vệ sinh 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 replay 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ật sự là id Claude | amazon-bedrock, anthropic-vertex |
google-gemini | Chính sách replay native của Gemini cộng với vệ sinh bootstrap replay và chế độ reasoning-output được gắn thẻ | google, google-gemini-cli |
passthrough-gemini | Vệ sinh thought-signature của 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 replay native của Gemini hoặc ghi lại bootstrap | openrouter, kilocode, opencode, opencode-go |
hybrid-anthropic-openai | Chính sách hybrid cho các nhà cung cấp trộn 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 |
| Nhóm | Nội dung kết nối vào | Ví dụ đi kèm |
|---|---|---|
google-thinking | Chuẩn hóa payload thinking của Gemini trên đường dẫn stream dùng chung | google, google-gemini-cli |
kilocode-thinking | Wrapper reasoning của Kilo trên đường dẫn proxy stream dùng chung, với kilo/auto và các id reasoning proxy không được hỗ trợ sẽ bỏ qua thinking đượ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 model ở chế độ nhanh của MiniMax trên đường dẫn stream dùng chung | minimax, minimax-portal |
openai-responses-defaults | Các wrapper Responses OpenAI/Codex native dùng chung: header phân bổ, /fast/serviceTier, độ chi tiết văn bản, tìm kiếm web native của Codex, định hình payload tương thích reasoning và quản lý ngữ cảnh Responses | openai, openai-codex |
openrouter-thinking | Wrapper reasoning của OpenRouter cho các tuyến proxy, với việc bỏ qua model 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 provider như Z.AI muốn stream công cụ trừ khi bị tắt rõ ràng | zai |
Các seam SDK hỗ trợ bộ dựng nhóm
Các seam SDK hỗ trợ bộ dựng nhóm
Mỗi bộ dựng nhóm được kết hợp từ các helper công khai cấp thấp hơn được export từ cùng package, bạn có thể dùng đến chúng khi một provider cần đi lệch khỏi mẫu chung:
openclaw/plugin-sdk/provider-model-shared—ProviderReplayFamily,buildProviderReplayFamilyHooks(...)và các bộ dựng replay thô (buildOpenAICompatibleReplayPolicy,buildAnthropicReplayPolicyForModel,buildGoogleGeminiReplayPolicy,buildHybridAnthropicOrOpenAIReplayPolicy). Cũng export các helper replay Gemini (sanitizeGoogleGeminiReplayHistory,resolveTaggedReasoningOutputMode) và helper endpoint/model (resolveProviderEndpoint,normalizeProviderId,normalizeGooglePreviewModelId,normalizeNativeXaiModelId).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 phần điền sẵn thinking của Anthropic Messages (createAnthropicThinkingPrefillPayloadWrapper) và các wrapper proxy/provider dùng chung (createOpenRouterWrapper,createToolStreamWrapper,createMinimaxFastModeWrapper).openclaw/plugin-sdk/provider-tools—ProviderToolCompatFamily,buildProviderToolCompatFamilyHooks("gemini"), các helper schema Gemini bên dưới (normalizeGeminiToolSchemas,inspectGeminiToolSchemas) và helper tương thích xAI (resolveXaiModelCompatPatch(),applyXaiModelCompat(model)). Plugin xAI đi kèm dùngnormalizeResolvedModel+contributeResolvedModelCompatcùng với các helper này để giữ quy tắc xAI do provider sở hữu.
@openclaw/anthropic-provider giữ wrapAnthropicProviderStream, resolveAnthropicBetas, resolveAnthropicFastMode, resolveAnthropicServiceTier và các bộ dựng wrapper Anthropic cấp thấp hơn trong seam công khai api.ts / contract-api.ts riêng vì chúng mã hóa xử lý Claude OAuth beta và cổng context1m. Plugin xAI cũng giữ phần định hình Responses native của xAI trong wrapStreamFn riêng (/fast aliases, tool_stream mặc định, dọn dẹp strict-tool không được hỗ trợ, gỡ bỏ payload reasoning dành riêng cho xAI).Mẫu package-root tương tự cũng hỗ trợ @openclaw/openai-provider (bộ dựng provider, helper model mặc định, bộ dựng provider realtime) và @openclaw/openrouter-provider (bộ dựng provider cộng với helper onboarding/cấu hình).- Trao đổi token
- Header tùy chỉnh
- Định danh transport native
- Mức dùng và thanh toán
Với các provider cần trao đổi token trước mỗi lần gọi suy luận:
Tất cả hook provider hiện có
Tất cả hook provider hiện có
OpenClaw gọi các hook theo thứ tự này. Hầu hết provider chỉ dùng 2-3 hook:
Các trường provider chỉ dành cho tương thích mà OpenClaw không còn gọi nữa, chẳng hạn như
Ghi chú fallback runtime:
ProviderPlugin.capabilities và suppressBuiltInModel, không được liệt kê
ở đây.| # | Hook | Khi nào dùng |
|---|---|---|
| 1 | catalog | Catalog model hoặc mặc định URL cơ sở |
| 2 | applyConfigDefaults | Mặc định toàn cục do provider sở hữu trong quá trình hiện thực hóa cấu hình |
| 3 | normalizeModelId | Dọn dẹp alias model-id legacy/preview trước khi tra cứu |
| 4 | normalizeTransport | Dọn dẹp api / baseUrl theo họ provider trước khi lắp ráp model 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 native cho provider cấu hình |
| 7 | resolveConfigApiKey | Phân giải xác thực env-marker do provider sở hữu |
| 8 | resolveSyntheticAuth | Xác thực tổng hợp cục bộ/tự host hoặc dựa trên cấu hình |
| 9 | shouldDeferSyntheticProfileAuth | Hạ độ ưu tiên placeholder hồ sơ đã 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 model 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 model vendor phía sau transport tương thích khác |
| 14 | normalizeToolSchemas | Dọn dẹp tool-schema do provider sở hữu trước khi đăng ký |
| 15 | inspectToolSchemas | Chẩn đoán tool-schema do provider sở hữu |
| 16 | resolveReasoningOutputMode | Hợp đồng reasoning-output dạng tagged so với native |
| 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 native theo từng lượt |
| 21 | resolveWebSocketSessionPolicy | Header/cool-down phiên WS native |
| 22 | formatApiKey | Hình 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 ngữ cảnh do provider sở hữu |
| 26 | classifyFailoverReason | Phân loại giới hạn tốc độ/quá tải do provider sở hữu |
| 27 | isCacheTtlEligible | Cổng TTL cache 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 | Tập tùy chọn /think theo model |
| 31 | isBinaryThinking | Tương thích thinking nhị phân bật/tắt |
| 32 | supportsXHighThinking | Tương thích hỗ trợ reasoning xhigh |
| 33 | resolveDefaultThinkingLevel | Tương thích chính sách /think mặc định |
| 34 | isModernModelRef | Khớp model 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 mức dùng tùy chỉnh |
| 37 | fetchUsageSnapshot | Endpoint mức dùng tùy chỉnh |
| 38 | createEmbeddingProvider | Adapter embedding do provider sở hữu cho bộ nhớ/tìm kiếm |
| 39 | buildReplayPolicy | Chính sách replay/Compaction transcript tùy chỉnh |
| 40 | sanitizeReplayHistory | Ghi lại replay dành riêng cho provider sau dọn dẹp chung |
| 41 | validateReplayTurns | Xác thực replay-turn nghiêm ngặt trước runner nhúng |
| 42 | onModelSelected | Callback sau khi chọn (ví dụ: telemetry) |
normalizeConfigkiểm tra provider đã khớp trước, sau đó đến các provider plugin khác có hook cho đến khi một hook thật sự thay đổi cấu hình. Nếu không hook provider 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 provider khi được cung cấp. Đường dẫnamazon-bedrockđi kèm cũng có trình phân giải env-marker AWS tích hợp sẵn tại đâ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 provider chèn hướng dẫn system-prompt nhận biết cache cho một họ model. Ưu tiên dùng nó thay vìbefore_prompt_buildkhi hành vi thuộc về một provider/họ model và cần giữ nguyên phân tách cache ổn định/động.
Thêm năng lực bổ sung (tùy chọn)
Một provider plugin có thể đăng ký speech, realtime transcription, realtime
voice, media understanding, image generation, video generation, 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 hybrid-capability — mẫu được khuyến nghị cho plugin của công ty
(một plugin cho mỗi vendor). Xem
Nội bộ: Quyền sở hữu năng lực.Đăng ký từng năng lực bên trong Dùng
register(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 các lỗi HTTP của nhà cung cấp để
các plugin chia sẻ việc đọc nội dung lỗi có giới hạn, phân tích lỗi JSON và
hậu tố mã định danh yêu cầu.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ự danh mục
catalog.order kiểm soát thời điểm danh mục của bạn được hợp nhất so 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 thuần túy |
profile | Sau simple | Nhà cung cấp bị ràng buộc 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 trùng) |
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 — trình trợ giúp
api.runtime(TTS, tìm kiếm, subagent) - Tổng quan SDK — tham chiếu nhập đầy đủ theo đường dẫn con
- Nội bộ Plugin — chi tiết hook và ví dụ tích hợp sẵn