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 gói
và thiết lập manifest cơ bản.
Hướng dẫn từng bước
Gói và manifest
Bước 1: Gói và manifest
setup.providers[].envVars để 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á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 văn bản tối thiểu cần có Dùng
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 các API
live của nhà cung cấ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 giao diện list/help/picker. 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à việc render trợ giúp.Đó 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ọ.Khám phá mô hình live
Nếu nhà cung cấp của bạn cung cấp một API kiểu/models, hãy giữ endpoint
dành riêng cho nhà cung cấp và phép chiếu hàng trong plugin của bạn, rồi dùng
openclaw/plugin-sdk/provider-catalog-live-runtime cho vòng đời fetch dùng chung.
Helper này cung cấp các HTTP fetch được bảo vệ, header xác thực nhà cung cấp,
lỗi HTTP có cấu trúc, bộ nhớ đệm TTL và hành vi fallback tĩnh mà không
đưa chính sách nhà cung cấp vào core OpenClaw.Dùng buildLiveModelProviderConfig khi API live chỉ cho bạn biết các hàng
danh mục tĩnh do nhà cung cấp sở hữu nào hiện đang khả dụng:index.ts
getCachedLiveProviderModelRows khi API nhà cung cấp trả về metadata
phong phú hơn và plugin cần tự chiếu các hàng thành định nghĩa mô hình
OpenClaw:index.ts
run nên luôn được chặn bằng xác thực và trả về null khi không có thông tin xác thực
dùng được. Giữ một staticRun ngoại tuyến hoặc fallback tĩnh để các bề mặt thiết lập,
tài liệu, kiểm thử và picker không phụ thuộc vào truy cập mạng live. Dùng TTL
phù hợp với độ mới của danh sách mô hình, tránh thăm dò hệ thống tệp tại thời điểm yêu cầu,
và chỉ truyền readRows / readModelId dành riêng cho nhà cung cấp khi
phản hồi upstream không có hình dạng tương thích OpenAI { data: [{ id, object }] }.Nếu nhà cung cấp upstream dùng các token điều khiển khác 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 system prompt cuối cùng và nội dung tin nhắn văn bản trước
transport. output viết 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 của chính nó hoặc gửi qua kênh.Với các nhà cung cấp bundled 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 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 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ực tế. Nó có thể thực hiện khám phá 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 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 thực hiện yêu cầu mạng. Màn hình models list --all của OpenClaw hiện chỉ thực thi catalog 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 gốc của 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 provider-id. supportsNativeStreamingUsageCompat(...) và applyProviderNativeStreamingUsageCompat(...) phát hiện hỗ trợ từ bản đồ capability của endpoint, vì vậy các endpoint gốc 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.Các ví dụ khám phá trực tiếp ở trên bao quát API nhà cung cấp kiểu /models. Giữ phần khám phá đó bên trong catalog.run, được chặn bởi xác thực có thể dùng được, và giữ staticRun không dùng mạng cho việc tạo catalog ngoại tuyến.Thêm phân giải mô hình động
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 một 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.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 khi nhà cung cấp của bạn yêu cầu.Các builder helper dùng chung hiện đã bao quát các nhóm replay/tool-compat phổ biến nhất, vì vậy Plugin thường không cần nối tay từng hook một:| Nhóm | Nội dung được nối vào | Ví dụ được đóng gói sẵn |
|---|---|---|
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 làm sạch tool-call-id, sửa thứ tự assistant-first 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, để transport Anthropic-message chỉ nhận cleanup thinking-block riêng cho Claude khi mô hình đã phân giải thực sự là id Claude | amazon-bedrock, anthropic-vertex |
google-gemini | Chính sách replay Gemini gốc cộng với làm sạch bootstrap replay. Nhóm dùng chung giữ Gemini CLI xuất văn bản trên tagged reasoning; nhà cung cấp google trực tiếp ghi đè resolveReasoningOutputMode thành native vì thinking của Gemini API đến dưới dạng native thought parts. | google, google-gemini-cli |
passthrough-gemini | Làm sạch thought-signature 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 Gemini gốc hoặc ghi lại bootstrap | openrouter, kilocode, opencode, opencode-go |
hybrid-anthropic-openai | Chính sách lai cho nhà cung cấp trộn bề mặt mô hình Anthropic-message 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 được nối vào | Ví dụ được đóng gói sẵn |
|---|---|---|
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 Kilo trên đường dẫn stream proxy dùng chung, với kilo/auto và các id proxy reasoning không được hỗ trợ 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 mô hình fast-mode của MiniMax trên đường dẫn stream dùng chung | minimax, minimax-portal |
openai-responses-defaults | Các wrapper Responses OpenAI/Codex gốc dùng chung: header attribution, /fast/serviceTier, độ dài chi tiết văn bản, tìm kiếm web Codex gốc, tạo hình payload reasoning-compat và quản lý ngữ cảnh Responses | openai |
openrouter-thinking | Wrapper reasoning OpenRouter cho các route proxy, với việc bỏ qua unsupported-model/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 |
Các seam SDK cung cấp năng lực cho family builder
Các seam SDK cung cấp năng lực cho family builder
Mỗi family builder được cấu thành 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 khi 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 builder replay thô (buildOpenAICompatibleReplayPolicy,buildAnthropicReplayPolicyForModel,buildGoogleGeminiReplayPolicy,buildHybridAnthropicOrOpenAIReplayPolicy). Cũng export các helper replay 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 DeepSeek V4 tương thích OpenAI (createDeepSeekV4OpenAICompatibleThinkingWrapper), cleanup prefill thinking Anthropic Messages (createAnthropicThinkingPrefillPayloadWrapper), compat tool-call văn bản thuần (createPlainTextToolCallCompatWrapper) và các wrapper proxy/nhà cung cấp dùng chung (createOpenRouterWrapper,createToolStreamWrapper,createMinimaxFastModeWrapper).openclaw/plugin-sdk/provider-stream-shared- các wrapper payload và event nhẹ cho đường dẫn nhà cung cấp nóng, bao gồmcreateOpenAICompatibleCompletionsThinkingOffWrapper,createPayloadPatchStreamWrapper,createPlainTextToolCallCompatWrapper,normalizeOpenAICompatibleReasoningPayload(...)vàsetQwenChatTemplateThinking(...).openclaw/plugin-sdk/provider-tools-ProviderToolCompatFamily,buildProviderToolCompatFamilyHooks("deepseek" | "gemini" | "openai")và các helper schema nhà cung cấp nền tảng.
native để OpenClaw tiêu thụ native thought parts mà không thêm chỉ thị prompt <think> / <final>. Các backend kiểu Gemini CLI chỉ có văn bản, phân tích phản hồi JSON/văn bản cuối cùng, có thể giữ hợp đồng tagged google-gemini dùng chung.Một số helper stream cố ý ở lại cục bộ theo nhà cung cấp. @openclaw/anthropic-provider giữ wrapAnthropicProviderStream, resolveAnthropicBetas, resolveAnthropicFastMode, resolveAnthropicServiceTier và các builder wrapper Anthropic cấp thấp hơn trong seam api.ts / contract-api.ts công khai riêng vì chúng mã hóa xử lý beta Claude OAuth và gating context1m. Plugin xAI tương tự giữ tạo hình Responses xAI gốc trong wrapStreamFn riêng của nó (bí danh /fast, tool_stream mặc định, cleanup strict-tool không được hỗ trợ, loại bỏ payload reasoning riêng cho xAI).Mẫu package-root tương tự cũng hỗ trợ @openclaw/openai-provider (builder nhà cung cấp, helper mô hình mặc định, builder nhà cung cấp realtime) và @openclaw/openrouter-provider (builder nhà cung cấp cộng với helper onboarding/cấu hình).- Trao đổi token
- Header tùy chỉnh
- Định danh transport gốc
- Mức sử dụng và thanh toán
Với các nhà cung cấp cần trao đổi token trước mỗi lệnh gọi inference:
Tất cả hook provider có sẵn
Tất cả hook provider có sẵn
OpenClaw gọi các hook theo thứ tự này. Hầu hết provider chỉ dùng 2-3:
Các trường provider chỉ dành cho tương thích mà OpenClaw không còn gọi, chẳng hạn như
Ghi chú về phương án dự phòng runtime:
ProviderPlugin.capabilities và suppressBuiltInModel, không được liệt kê
ở đây.| # | Hook | Khi nào sử dụng |
|---|---|---|
| 1 | catalog | Catalog model hoặc mặc định URL cơ sở |
| 2 | applyConfigDefaults | Các mặc định toàn cục do provider sở hữu trong quá trình vật chất hóa cấu hình |
| 3 | normalizeModelId | Dọn dẹp alias model-id cũ/bản xem trước 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 gốc cho các 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 local/tự host hoặc dựa trên cấu hình |
| 9 | shouldDeferSyntheticProfileAuth | Hạ mức placeholder profile đã lưu tổng hợp xuống 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 | normalizeToolSchemas | Dọn dẹp tool-schema do provider sở hữu trước khi đăng ký |
| 14 | inspectToolSchemas | Chẩn đoán tool-schema do provider sở hữu |
| 15 | resolveReasoningOutputMode | Hợp đồng reasoning-output được gắn thẻ so với gốc |
| 16 | prepareExtraParams | Tham số yêu cầu mặc định |
| 17 | createStreamFn | Transport StreamFn tùy chỉnh hoàn toàn |
| 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 | 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 do provider sở hữu |
| 26 | classifyFailoverReason | Phân loại rate-limit/quá tải do provider sở hữu |
| 27 | isCacheTtlEligible | Chặn TTL cache prompt |
| 28 | buildMissingAuthMessage | Gợi ý thiếu xác thực tùy chỉnh |
| 29 | augmentModelCatalog | Hàng tổng hợp tương thích tiến về sau |
| 30 | resolveThinkingProfile | Bộ tùy chọn /think theo model |
| 31 | isBinaryThinking | Tương thích bật/tắt suy nghĩ nhị phân |
| 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 sử dụng tùy chỉnh |
| 37 | fetchUsageSnapshot | Endpoint mức sử 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 phát lại transcript/compaction tùy chỉnh |
| 40 | sanitizeReplayHistory | Ghi lại phát lại theo provider sau bước 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 provider khớp trước, rồi đến các provider plugin khác có hỗ trợ hook cho đến khi có một provider 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ợ, bộ chuẩn hóa cấu hình Google đi kèm vẫn được áp dụng.resolveConfigApiKeydùng hook provider khi được công bố. Amazon Bedrock giữ phân giải env-marker AWS trong provider plugin của nó; bản thân xác thực runtime vẫn dùng chuỗi mặc định AWS SDK khi được cấu hình vớiauth: "aws-sdk".resolveThinkingProfile(ctx)nhậnprovider,modelIdđã chọn, gợi ý catalogreasoningđã hợp nhất tùy chọn, và các dữ kiệncompatmodel đã hợp nhất tùy chọn. Chỉ dùngcompatđể chọn UI/profile thinking của provider.resolveSystemPromptContributioncho phép provider chèn hướng dẫn system-prompt có nhận biết cache cho một họ model. Ưu tiên nó hơnbefore_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 khả năng bổ sung (tùy chọn)
Bước 5: Thêm khả năng bổ sung
Một provider plugin có thể đăng ký embedding, speech, phiên âm realtime, giọng nói realtime, hiểu media, 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à plugin hybrid-capability - mẫu được khuyến nghị cho plugin công ty (mỗi vendor một plugin). Xem Nội bộ: Quyền sở hữu Capability.Đăng ký từng capability 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)
- Phiên âm realtime
- Giọng nói realtime
- Media understanding
- Embeddings
- Image and video generation
- Web fetch and search
assertOkOrThrowProviderError(...) cho lỗi HTTP provider để
các plugin chia sẻ việc đọ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
Các plugin nhà cung cấp được xuất bản giống như mọi plugin mã bên 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 tiên | Nhà cung cấp API-key đơn giản |
profile | Sau simple | Nhà cung cấp được kiểm soát bằng 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) |
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 subpath đầy đủ
- Nội bộ Plugin - chi tiết hook và ví dụ tích hợp sẵn