Plugin SDK 會以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.
openclaw/plugin-sdk/ 下的一組窄範圍子路徑公開。
本頁依用途分組列出常用子路徑。產生的
200+ 個子路徑完整清單位於 scripts/lib/plugin-sdk-entrypoints.json;
保留給 bundled-plugin 輔助工具的子路徑會出現在該處,但除非文件頁面明確提升其地位,否則它們屬於實作
細節。維護者可以使用 pnpm plugins:boundary-report:summary 稽核使用中的
保留輔助工具子路徑;未使用的保留輔助工具匯出會讓 CI 報告失敗,而不是以休眠的相容性負債形式留在公開 SDK
中。
如需 Plugin 編寫指南,請參閱 Plugin SDK 概觀。
Plugin 入口
| 子路徑 | 主要匯出 |
|---|---|
plugin-sdk/plugin-entry | definePluginEntry |
plugin-sdk/core | defineChannelPluginEntry, createChatChannelPlugin, createChannelPluginBase, defineSetupPluginEntry, buildChannelConfigSchema |
plugin-sdk/config-schema | OpenClawSchema |
plugin-sdk/provider-entry | defineSingleProviderPluginEntry |
plugin-sdk/testing | 舊版 Plugin 測試的廣泛相容性 barrel;新的 extension 測試應優先使用聚焦的測試子路徑 |
plugin-sdk/plugin-test-api | 用於直接 Plugin 註冊單元測試的最小 OpenClawPluginApi 模擬建構器 |
plugin-sdk/agent-runtime-test-contracts | 原生 agent-runtime adapter contract fixtures,適用於 auth profiles、delivery suppression、fallback classification、tool hooks、prompt overlays、schemas,以及 transcript repair |
plugin-sdk/channel-test-helpers | 頻道帳號生命週期、目錄、send-config、runtime mock、hook、bundled channel entry、envelope timestamp、pairing reply,以及通用頻道 contract 測試輔助工具 |
plugin-sdk/channel-target-testing | 共用頻道 target-resolution 錯誤案例測試套件 |
plugin-sdk/plugin-test-contracts | Plugin 註冊、套件 manifest、公開 artifact、runtime API、import side-effect,以及直接 import contract 輔助工具 |
plugin-sdk/plugin-test-runtime | 測試用的 Plugin runtime、registry、provider-registration、setup-wizard,以及 runtime task-flow fixtures |
plugin-sdk/provider-test-contracts | Provider runtime、auth、discovery、onboard、catalog、media capability、replay policy、realtime STT live-audio、web-search/fetch,以及 wizard contract 輔助工具 |
plugin-sdk/provider-http-test-mocks | 選用的 Vitest HTTP/auth mocks,供會運用 plugin-sdk/provider-http 的 provider 測試使用 |
plugin-sdk/test-env | 測試環境、fetch/network、可拋棄 HTTP 伺服器、incoming request、live-test、暫存檔案系統,以及 time-control fixtures |
plugin-sdk/test-fixtures | 通用 CLI、sandbox、skill、agent-message、system-event、module reload、bundled Plugin path、terminal、chunking、auth-token,以及 typed-case 測試 fixtures |
plugin-sdk/test-node-mocks | 聚焦的 Node builtin mock 輔助工具,用於 Vitest vi.mock("node:*") factories 內 |
plugin-sdk/migration | Migration provider item 輔助工具,例如 createMigrationItem、reason constants、item status markers、redaction helpers,以及 summarizeMigrationItems |
plugin-sdk/migration-runtime | Runtime migration 輔助工具,例如 copyMigrationFileItem、withCachedMigrationConfigRuntime,以及 writeMigrationReport |
頻道子路徑
頻道子路徑
提供者子路徑
提供者子路徑
驗證與安全性子路徑
驗證與安全性子路徑
| 子路徑 | 主要匯出 |
|---|---|
plugin-sdk/command-auth | resolveControlCommandGate、命令登錄輔助工具(包含動態引數選單格式化)、傳送者授權輔助工具 |
plugin-sdk/command-status | 命令/說明訊息建構器,例如 buildCommandsMessagePaginated 和 buildHelpMessage |
plugin-sdk/approval-auth-runtime | 核准者解析與同一聊天動作驗證輔助工具 |
plugin-sdk/approval-client-runtime | 原生 exec 核准設定檔/篩選器輔助工具 |
plugin-sdk/approval-delivery-runtime | 原生核准能力/傳遞配接器 |
plugin-sdk/approval-gateway-runtime | 共用核准 Gateway 解析輔助工具 |
plugin-sdk/approval-handler-adapter-runtime | 熱通道進入點的輕量原生核准配接器載入輔助工具 |
plugin-sdk/approval-handler-runtime | 較廣泛的核准處理器執行階段輔助工具;當較精簡的配接器/Gateway 接縫足夠時,請優先使用它們 |
plugin-sdk/approval-native-runtime | 原生核准目標 + 帳戶繫結輔助工具 |
plugin-sdk/approval-reply-runtime | Exec/Plugin 核准回覆承載輔助工具 |
plugin-sdk/approval-runtime | Exec/Plugin 核准承載輔助工具、原生核准路由/執行階段輔助工具,以及結構化核准顯示輔助工具,例如 formatApprovalDisplayPath |
plugin-sdk/reply-dedupe | 精簡的傳入回覆去重重設輔助工具 |
plugin-sdk/channel-contract-testing | 不含廣泛測試 barrel 的精簡通道合約測試輔助工具 |
plugin-sdk/command-auth-native | 原生命令驗證、動態引數選單格式化,以及原生工作階段目標輔助工具 |
plugin-sdk/command-detection | 共用命令偵測輔助工具 |
plugin-sdk/command-primitives-runtime | 熱通道路徑的輕量命令文字述詞 |
plugin-sdk/command-surface | 命令本文正規化與命令介面輔助工具 |
plugin-sdk/allow-from | formatAllowFromLowercase |
plugin-sdk/channel-secret-runtime | 通道/Plugin 秘密介面的精簡秘密合約收集輔助工具 |
plugin-sdk/secret-ref-runtime | 用於秘密合約/設定剖析的精簡 coerceSecretRef 與 SecretRef 型別輔助工具 |
plugin-sdk/security-runtime | 共用信任、DM 閘控、外部內容、敏感文字遮蔽、常數時間秘密比較,以及秘密收集輔助工具 |
plugin-sdk/ssrf-policy | 主機允許清單與私人網路 SSRF 原則輔助工具 |
plugin-sdk/ssrf-dispatcher | 不含廣泛基礎架構執行階段介面的精簡釘選派送器輔助工具 |
plugin-sdk/ssrf-runtime | 釘選派送器、SSRF 保護擷取、SSRF 錯誤,以及 SSRF 原則輔助工具 |
plugin-sdk/secret-input | 秘密輸入剖析輔助工具 |
plugin-sdk/webhook-ingress | Webhook 請求/目標輔助工具,以及原始 websocket/本文強制轉型 |
plugin-sdk/webhook-request-guards | 請求本文大小/逾時輔助工具 |
執行階段與儲存子路徑
執行階段與儲存子路徑
功能與測試子路徑
功能與測試子路徑
| 子路徑 | 主要匯出 |
|---|---|
plugin-sdk/media-runtime | 共用媒體擷取/轉換/儲存輔助程式、以 ffprobe 支援的影片尺寸探測,以及媒體承載資料建構器 |
plugin-sdk/media-store | 精簡媒體儲存輔助程式,例如 saveMediaBuffer |
plugin-sdk/media-generation-runtime | 共用媒體生成容錯移轉輔助程式、候選項選取,以及缺少模型的訊息 |
plugin-sdk/media-understanding | 媒體理解提供者型別,以及面向提供者的影像/音訊輔助匯出 |
plugin-sdk/text-runtime | 共用文字/markdown/記錄輔助程式,例如移除助理可見文字、markdown 轉譯/分塊/表格輔助程式、遮蔽輔助程式、指令標籤輔助程式,以及安全文字工具 |
plugin-sdk/text-chunking | 輸出文字分塊輔助程式 |
plugin-sdk/speech | 語音提供者型別,以及面向提供者的指令、登錄、驗證、OpenAI 相容 TTS 建構器與語音輔助匯出 |
plugin-sdk/speech-core | 共用語音提供者型別、登錄、指令、正規化與語音輔助匯出 |
plugin-sdk/realtime-transcription | 即時轉錄提供者型別、登錄輔助程式,以及共用 WebSocket 工作階段輔助程式 |
plugin-sdk/realtime-voice | 即時語音提供者型別與登錄輔助程式 |
plugin-sdk/image-generation | 影像生成提供者型別,以及影像資產/資料 URL 輔助程式與 OpenAI 相容影像提供者建構器 |
plugin-sdk/image-generation-core | 共用影像生成型別、容錯移轉、驗證與登錄輔助程式 |
plugin-sdk/music-generation | 音樂生成提供者/請求/結果型別 |
plugin-sdk/music-generation-core | 共用音樂生成型別、容錯移轉輔助程式、提供者查詢,以及模型參照剖析 |
plugin-sdk/video-generation | 影片生成提供者/請求/結果型別 |
plugin-sdk/video-generation-core | 共用影片生成型別、容錯移轉輔助程式、提供者查詢,以及模型參照剖析 |
plugin-sdk/webhook-targets | Webhook 目標登錄與路由安裝輔助程式 |
plugin-sdk/webhook-path | Webhook 路徑正規化輔助程式 |
plugin-sdk/web-media | 共用遠端/本機媒體載入輔助程式 |
plugin-sdk/zod | 為 plugin SDK 使用者重新匯出的 zod |
plugin-sdk/testing | 舊版 plugin 測試的廣泛相容性匯出桶。新的 extension 測試應改為匯入聚焦的 SDK 子路徑,例如 plugin-sdk/agent-runtime-test-contracts、plugin-sdk/plugin-test-runtime、plugin-sdk/channel-test-helpers、plugin-sdk/test-env 或 plugin-sdk/test-fixtures |
plugin-sdk/plugin-test-api | 最小化的 createTestPluginApi 輔助程式,用於直接 plugin 註冊單元測試,而不匯入 repo 測試輔助橋接 |
plugin-sdk/agent-runtime-test-contracts | 原生代理執行階段配接器合約 fixtures,用於驗證、遞送、後援、工具鉤子、提示詞覆蓋、schema 與轉錄投影測試 |
plugin-sdk/channel-test-helpers | 面向通道的測試輔助程式,用於通用動作/設定/狀態合約、目錄斷言、帳戶啟動生命週期、send-config threading、執行階段 mock、狀態問題、輸出遞送與鉤子註冊 |
plugin-sdk/channel-target-testing | 通道測試的共用目標解析錯誤案例套件 |
plugin-sdk/plugin-test-contracts | Plugin 套件、註冊、公開成品、直接匯入、執行階段 API 與匯入副作用合約輔助程式 |
plugin-sdk/provider-test-contracts | 提供者執行階段、驗證、探索、onboard、目錄、精靈、媒體功能、重播原則、即時 STT 現場音訊、網頁搜尋/擷取與串流合約輔助程式 |
plugin-sdk/provider-http-test-mocks | 可選用的 Vitest HTTP/驗證 mock,用於測試會運用 plugin-sdk/provider-http 的提供者 |
plugin-sdk/test-fixtures | 通用 CLI 執行階段擷取、沙盒情境、skill writer、agent-message、system-event、模組重新載入、內建 plugin 路徑、terminal-text、分塊、auth-token 與 typed-case fixtures |
plugin-sdk/test-node-mocks | 聚焦的 Node 內建 mock 輔助程式,用於 Vitest vi.mock("node:*") factory 內 |
記憶體子路徑
記憶體子路徑
| 子路徑 | 主要匯出 |
|---|---|
plugin-sdk/memory-core | 針對 manager/config/file/CLI 輔助程式的內建 memory-core 輔助表面 |
plugin-sdk/memory-core-engine-runtime | 記憶體索引/搜尋執行階段 facade |
plugin-sdk/memory-core-host-engine-foundation | 記憶體主機基礎引擎匯出 |
plugin-sdk/memory-core-host-engine-embeddings | 記憶體主機嵌入合約、登錄存取、本機提供者,以及通用批次/遠端輔助程式 |
plugin-sdk/memory-core-host-engine-qmd | 記憶體主機 QMD 引擎匯出 |
plugin-sdk/memory-core-host-engine-storage | 記憶體主機儲存引擎匯出 |
plugin-sdk/memory-core-host-multimodal | 記憶體主機多模態輔助程式 |
plugin-sdk/memory-core-host-query | 記憶體主機查詢輔助程式 |
plugin-sdk/memory-core-host-secret | 記憶體主機秘密輔助程式 |
plugin-sdk/memory-core-host-events | 記憶體主機事件日誌輔助程式 |
plugin-sdk/memory-core-host-status | 記憶體主機狀態輔助程式 |
plugin-sdk/memory-core-host-runtime-cli | 記憶體主機 CLI 執行階段輔助程式 |
plugin-sdk/memory-core-host-runtime-core | 記憶體主機核心執行階段輔助程式 |
plugin-sdk/memory-core-host-runtime-files | 記憶體主機檔案/執行階段輔助程式 |
plugin-sdk/memory-host-core | 記憶體主機核心執行階段輔助程式的廠商中立別名 |
plugin-sdk/memory-host-events | 記憶體主機事件日誌輔助程式的廠商中立別名 |
plugin-sdk/memory-host-files | 記憶體主機檔案/執行階段輔助程式的廠商中立別名 |
plugin-sdk/memory-host-markdown | 供記憶體相鄰 plugins 使用的共用受管理 markdown 輔助程式 |
plugin-sdk/memory-host-search | 用於 search-manager 存取的 Active Memory 執行階段 facade |
plugin-sdk/memory-host-status | 記憶體主機狀態輔助程式的廠商中立別名 |
保留的內建輔助子路徑
保留的內建輔助子路徑
目前沒有保留的內建輔助 SDK 子路徑。擁有者特定的
輔助程式位於所屬的 plugin 套件內,而可重用的主機合約
使用通用 SDK 子路徑,例如
plugin-sdk/gateway-runtime、
plugin-sdk/security-runtime 與 plugin-sdk/plugin-config-runtime。