跳轉到主要內容

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.

Plugin SDK 會以 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-entrydefinePluginEntry
plugin-sdk/coredefineChannelPluginEntry, createChatChannelPlugin, createChannelPluginBase, defineSetupPluginEntry, buildChannelConfigSchema
plugin-sdk/config-schemaOpenClawSchema
plugin-sdk/provider-entrydefineSingleProviderPluginEntry
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-contractsPlugin 註冊、套件 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-contractsProvider 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/migrationMigration provider item 輔助工具,例如 createMigrationItem、reason constants、item status markers、redaction helpers,以及 summarizeMigrationItems
plugin-sdk/migration-runtimeRuntime migration 輔助工具,例如 copyMigrationFileItemwithCachedMigrationConfigRuntime,以及 writeMigrationReport
子路徑主要匯出
plugin-sdk/channel-coredefineChannelPluginEntry, defineSetupPluginEntry, createChatChannelPlugin, createChannelPluginBase
plugin-sdk/config-schemaopenclaw.json Zod schema 匯出 (OpenClawSchema)
plugin-sdk/channel-setupcreateOptionalChannelSetupSurface, createOptionalChannelSetupAdapter, createOptionalChannelSetupWizard,以及 DEFAULT_ACCOUNT_ID, createTopLevelChannelDmPolicy, setSetupChannelEnabled, splitSetupEntries
plugin-sdk/setup共用 setup wizard 輔助工具、allowlist prompts、setup status builders
plugin-sdk/setup-runtimecreatePatchedAccountSetupAdapter, createEnvPatchedAccountSetupAdapter, createSetupInputPresenceValidator, noteChannelLookupFailure, noteChannelLookupSummary, promptResolvedAllowFrom, splitSetupEntries, createAllowlistSetupWizardProxy, createDelegatedSetupWizardProxy
plugin-sdk/setup-adapter-runtimecreateEnvPatchedAccountSetupAdapter
plugin-sdk/setup-toolsformatCliCommand, detectBinary, extractArchive, resolveBrewExecutable, formatDocsLink, CONFIG_DIR
plugin-sdk/account-core多帳號 config/action-gate 輔助工具、default-account fallback 輔助工具
plugin-sdk/account-idDEFAULT_ACCOUNT_ID、account-id 正規化輔助工具
plugin-sdk/account-resolution帳號查找 + default-fallback 輔助工具
plugin-sdk/account-helpers窄範圍 account-list/account-action 輔助工具
plugin-sdk/channel-pairingcreateChannelPairingController
plugin-sdk/channel-reply-pipelinecreateChannelReplyPipeline, resolveChannelSourceReplyDeliveryMode
plugin-sdk/channel-config-helperscreateHybridChannelConfigAdapter, resolveChannelDmAccess, resolveChannelDmAllowFrom, resolveChannelDmPolicy, normalizeChannelDmPolicy, normalizeLegacyDmAliases
plugin-sdk/channel-config-schema共用頻道 config schema primitives 與通用 builder
plugin-sdk/bundled-channel-config-schema僅供維護中的 bundled plugins 使用的 bundled OpenClaw 頻道 config schemas
plugin-sdk/channel-config-schema-legacybundled-channel config schemas 的已棄用相容性別名
plugin-sdk/telegram-command-configTelegram custom-command 正規化/驗證輔助工具,含 bundled-contract fallback
plugin-sdk/command-gating窄範圍命令授權 gate 輔助工具
plugin-sdk/channel-policyresolveChannelGroupRequireMention
plugin-sdk/channel-lifecyclecreateAccountStatusSink, createChannelRunQueue、draft stream lifecycle/finalization 輔助工具
plugin-sdk/inbound-envelope共用 inbound route + envelope builder 輔助工具
plugin-sdk/inbound-reply-dispatch共用 inbound record-and-dispatch 輔助工具
plugin-sdk/messaging-targetsTarget parsing/matching 輔助工具
plugin-sdk/outbound-media共用 outbound media loading 輔助工具
plugin-sdk/outbound-send-depsChannel adapters 的輕量 outbound send dependency lookup
plugin-sdk/outbound-runtimeOutbound delivery、identity、send delegate、session、formatting,以及 payload planning 輔助工具
plugin-sdk/poll-runtime窄範圍 poll normalization 輔助工具
plugin-sdk/thread-bindings-runtimeThread-binding lifecycle 與 adapter 輔助工具
plugin-sdk/agent-media-payload舊版 agent media payload builder
plugin-sdk/conversation-runtimeConversation/thread binding、pairing,以及 configured-binding 輔助工具
plugin-sdk/runtime-config-snapshotRuntime config snapshot 輔助工具
plugin-sdk/runtime-group-policyRuntime group-policy resolution 輔助工具
plugin-sdk/channel-status共用頻道 status snapshot/summary 輔助工具
plugin-sdk/channel-config-primitives窄範圍頻道 config-schema primitives
plugin-sdk/channel-config-writes頻道 config-write authorization 輔助工具
plugin-sdk/channel-plugin-common共用頻道 Plugin prelude 匯出
plugin-sdk/allowlist-config-editAllowlist config edit/read 輔助工具
plugin-sdk/group-access共用 group-access decision 輔助工具
plugin-sdk/direct-dm共用 direct-DM auth/guard 輔助工具
plugin-sdk/discord已棄用的 Discord 相容性 facade,用於已發布的 @openclaw/discord@2026.3.13 與已追蹤的 owner 相容性;新的 plugins 應使用通用頻道 SDK 子路徑
plugin-sdk/telegram-account已棄用的 Telegram account-resolution 相容性 facade,用於已追蹤的 owner 相容性;新的 plugins 應使用注入的 runtime 輔助工具或通用頻道 SDK 子路徑
plugin-sdk/interactive-runtime語意訊息呈現、delivery,以及舊版 interactive reply 輔助工具。請參閱 訊息呈現
plugin-sdk/channel-inboundInbound debounce、mention matching、mention-policy 輔助工具,以及 envelope 輔助工具的相容性 barrel
plugin-sdk/channel-inbound-debounce窄範圍 inbound debounce 輔助工具
plugin-sdk/channel-mention-gating窄範圍 mention-policy、mention marker,以及 mention text 輔助工具,不含較廣的 inbound runtime surface
plugin-sdk/channel-envelope窄範圍 inbound envelope formatting 輔助工具
plugin-sdk/channel-location頻道 location context 與 formatting 輔助工具
plugin-sdk/channel-loggingInbound drops 與 typing/ack failures 的頻道 logging 輔助工具
plugin-sdk/channel-send-resultReply result types
plugin-sdk/channel-actions頻道 message-action 輔助工具,以及為 Plugin 相容性保留的已棄用 native schema 輔助工具
plugin-sdk/channel-route共用 route normalization、parser-driven target resolution、thread-id stringification、dedupe/compact route keys、parsed-target types,以及 route/target comparison 輔助工具
plugin-sdk/channel-targetsTarget parsing 輔助工具;route comparison callers 應使用 plugin-sdk/channel-route
plugin-sdk/channel-contract頻道 contract types
plugin-sdk/channel-feedbackFeedback/reaction wiring
plugin-sdk/channel-secret-runtime窄範圍 secret-contract 輔助工具,例如 collectSimpleChannelFieldAssignmentsgetChannelSurfacepushAssignment,以及 secret target types
子路徑主要匯出
plugin-sdk/provider-entrydefineSingleProviderPluginEntry
plugin-sdk/lmstudio支援的 LM Studio 提供者外觀介面,用於設定、目錄探索與執行階段模型準備
plugin-sdk/lmstudio-runtime支援的 LM Studio 執行階段外觀介面,用於本機伺服器預設值、模型探索、請求標頭與已載入模型輔助工具
plugin-sdk/provider-setup精選的本機/自架提供者設定輔助工具
plugin-sdk/self-hosted-provider-setup專注於 OpenAI 相容自架提供者的設定輔助工具
plugin-sdk/cli-backendCLI 後端預設值 + 看門狗常數
plugin-sdk/provider-auth-runtime提供者 Plugin 的執行階段 API 金鑰解析輔助工具
plugin-sdk/provider-auth-api-keyAPI 金鑰入門/設定檔寫入輔助工具,例如 upsertApiKeyProfile
plugin-sdk/provider-auth-result標準 OAuth 驗證結果建構器
plugin-sdk/provider-auth-login提供者 Plugin 共用的互動式登入輔助工具
plugin-sdk/provider-env-vars提供者驗證環境變數查詢輔助工具
plugin-sdk/provider-authcreateProviderApiKeyAuthMethod, ensureApiKeyFromOptionEnvOrPrompt, upsertAuthProfile, upsertApiKeyProfile, writeOAuthCredentials
plugin-sdk/provider-model-sharedProviderReplayFamily, buildProviderReplayFamilyHooks, normalizeModelCompat, 共用重播原則建構器、提供者端點輔助工具,以及模型 ID 正規化輔助工具,例如 normalizeNativeXaiModelId
plugin-sdk/provider-catalog-runtime提供者目錄增補執行階段鉤子,以及用於合約測試的 Plugin 提供者登錄接縫
plugin-sdk/provider-catalog-sharedfindCatalogTemplate, buildSingleProviderApiKeyCatalog, buildManifestModelProviderConfig, supportsNativeStreamingUsageCompat, applyProviderNativeStreamingUsageCompat
plugin-sdk/provider-http通用提供者 HTTP/端點能力輔助工具、提供者 HTTP 錯誤,以及音訊轉錄 multipart 表單輔助工具
plugin-sdk/provider-web-fetch-contract精簡的網頁擷取設定/選擇合約輔助工具,例如 enablePluginInConfigWebFetchProviderPlugin
plugin-sdk/provider-web-fetch網頁擷取提供者註冊/快取輔助工具
plugin-sdk/provider-web-search-config-contract精簡的網頁搜尋設定/憑證輔助工具,適用於不需要 Plugin 啟用接線的提供者
plugin-sdk/provider-web-search-contract精簡的網頁搜尋設定/憑證合約輔助工具,例如 createWebSearchProviderContractFields, enablePluginInConfig, resolveProviderWebSearchPluginConfig,以及具作用域的憑證設定器/取得器
plugin-sdk/provider-web-search網頁搜尋提供者註冊/快取/執行階段輔助工具
plugin-sdk/provider-toolsProviderToolCompatFamily, buildProviderToolCompatFamilyHooks, Gemini 結構描述清理 + 診斷,以及 xAI 相容性輔助工具,例如 resolveXaiModelCompatPatch / applyXaiModelCompat
plugin-sdk/provider-usagefetchClaudeUsage 及類似項目
plugin-sdk/provider-streamProviderStreamFamily, buildProviderStreamFamilyHooks, composeProviderStreamWrappers, 串流包裝器型別,以及共用 Anthropic/Bedrock/DeepSeek V4/Google/Kilocode/Moonshot/OpenAI/OpenRouter/Z.A.I/MiniMax/Copilot 包裝器輔助工具
plugin-sdk/provider-transport-runtime原生提供者傳輸輔助工具,例如受保護的擷取、傳輸訊息轉換,以及可寫入傳輸事件串流
plugin-sdk/provider-onboard入門設定修補輔助工具
plugin-sdk/global-singleton行程本機單例/對映/快取輔助工具
plugin-sdk/group-activation精簡的群組啟用模式與命令剖析輔助工具
子路徑主要匯出
plugin-sdk/command-authresolveControlCommandGate、命令登錄輔助工具(包含動態引數選單格式化)、傳送者授權輔助工具
plugin-sdk/command-status命令/說明訊息建構器,例如 buildCommandsMessagePaginatedbuildHelpMessage
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-runtimeExec/Plugin 核准回覆承載輔助工具
plugin-sdk/approval-runtimeExec/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-fromformatAllowFromLowercase
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-ingressWebhook 請求/目標輔助工具,以及原始 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-targetsWebhook 目標登錄與路由安裝輔助程式
plugin-sdk/webhook-pathWebhook 路徑正規化輔助程式
plugin-sdk/web-media共用遠端/本機媒體載入輔助程式
plugin-sdk/zod為 plugin SDK 使用者重新匯出的 zod
plugin-sdk/testing舊版 plugin 測試的廣泛相容性匯出桶。新的 extension 測試應改為匯入聚焦的 SDK 子路徑,例如 plugin-sdk/agent-runtime-test-contractsplugin-sdk/plugin-test-runtimeplugin-sdk/channel-test-helpersplugin-sdk/test-envplugin-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-contractsPlugin 套件、註冊、公開成品、直接匯入、執行階段 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-runtimeplugin-sdk/security-runtimeplugin-sdk/plugin-config-runtime

相關