Skip to main content
外掛 SDK 包含狹窄的公開子路徑,以及位於 openclaw/plugin-sdk/ 下、僅供儲存庫使用的內建輔助程式。本頁列出兩者,並明確標示私有本機項目。以下三個檔案定義其邊界:
  • scripts/lib/plugin-sdk-entrypoints.json:建置時編譯的維護中進入點清單。
  • scripts/lib/plugin-sdk-private-local-only-subpaths.json:從具型別且有文件記載的 SDK 中排除的內部子路徑。正式環境項目仍以僅 JavaScript 的主機執行階段匯出形式,供另行發布的官方外掛使用;僅供測試的項目則維持不匯出。
  • src/plugin-sdk/entrypoints.ts:已棄用子路徑、保留的內建輔助程式、支援的內建外觀介面,以及外掛擁有的公開介面之分類中繼資料。
維護者使用 pnpm plugin-sdk:surface 稽核公開匯出數量,並使用 pnpm plugins:boundary-report:summary 稽核使用中的保留輔助子路徑;未使用的保留輔助匯出會導致 CI 報告失敗,而不會以休眠的相容性債務形式留在公開 SDK 中。 如需外掛編寫指南,請參閱外掛 SDK 概觀

外掛進入點

相容性與私有本機輔助程式

只有較晚時段的已棄用子路徑仍維持匯出。2026 年 7 月的別名與未使用子路徑已刪除,而僅供內建使用的輔助程式已從公開套件移除,並在下方標示為私有本機。維護中的清單是 scripts/lib/plugin-sdk-deprecated-public-subpaths.json;CI 會拒絕內建 plugin-sdk/text-runtime 僅供相容性使用,而 plugin-sdk/zod 是相容性重新匯出:請直接從 zod 匯入 zod。廣泛的領域彙總進入點 plugin-sdk/agent-runtimeplugin-sdk/channel-lifecycleplugin-sdk/conversation-runtimeplugin-sdk/hook-runtimeplugin-sdk/media-runtimeplugin-sdk/plugin-runtimeplugin-sdk/security-runtime 也同樣已棄用,應改用聚焦的子路徑。 OpenClaw 以 Vitest 為基礎的測試輔助子路徑僅供儲存庫本機使用,且不再是套件匯出:agent-runtime-test-contractschannel-contract-testingchannel-target-testingchannel-test-helpersplugin-state-test-runtimeplugin-test-apiplugin-test-contractsplugin-test-runtimeprovider-http-test-mocksprovider-test-contractsreply-payload-testingsqlite-runtime-testingtest-envtest-fixturestest-livetest-live-authtest-media-generationtest-media-understandingtest-node-mockstesting。私有內建輔助介面 ssrf-runtime-internalcodex-native-task-runtime 也僅供儲存庫本機使用。

內建外掛輔助子路徑

在 2026 年 7 月清理後,僅供內建使用的輔助模組改為私有本機。套件合約防護機制會封鎖跨擁有者匯入。src/plugin-sdk/entrypoints.ts 另行追蹤仍維持公開的受支援內建外觀介面,也就是由其內建外掛支援的 SDK 進入點,直到通用合約取代 plugin-sdk/qa-runner-runtimeplugin-sdk/telegram-account;不建議新程式碼使用,請參閱下方各列附註。
較晚時段的頻道相容性子路徑僅在其登錄日期內維持公開。直接私訊存取、回覆選項、配對路徑及頻道執行階段分支等 7 月別名均已移除;僅供內建使用的輔助程式則為私有本機。
供應商用量快照通常會回報一或多個配額 windows,每個項目都包含 標籤、已使用百分比,以及選用的重設時間。若供應商公開的是餘額或 帳戶狀態文字,而非可重設的配額期間,則應回傳 summary 並使用空的 windows 陣列,而不是捏造百分比。 OpenClaw 會在狀態輸出中顯示該摘要文字;僅當 用量端點失敗或未回傳可用的用量資料時,才使用 error
保留的隨附輔助函式 SDK 子路徑,是供隨附外掛程式碼使用、範圍精簡且由特定擁有者管理的介面。這些子路徑會列入 SDK 清單中追蹤,讓套件建置與別名處理維持確定性,但它們不是通用的外掛開發 API。新的可重用主機合約應使用通用 SDK 子路徑,例如 plugin-sdk/gateway-runtimeplugin-sdk/ssrf-runtime

相關內容