Skip to main content
Das Plugin-SDK enthält schmale öffentliche Unterpfade und ausschließlich im Repository verfügbare gebündelte Hilfsfunktionen unter openclaw/plugin-sdk/. Diese Seite katalogisiert beide und kennzeichnet private-lokale Einträge ausdrücklich. Drei Dateien definieren die Grenze:
  • scripts/lib/plugin-sdk-entrypoints.json: das gepflegte Inventar der Einstiegspunkte, das vom Build kompiliert wird.
  • scripts/lib/plugin-sdk-private-local-only-subpaths.json: interne Unterpfade, die vom typisierten, dokumentierten SDK ausgeschlossen sind. Produktionseinträge bleiben als reine JavaScript-Exporte der Host-Laufzeit für separat veröffentlichte offizielle Plugins verfügbar; reine Testeinträge bleiben nicht exportiert.
  • src/plugin-sdk/entrypoints.ts: Klassifizierungsmetadaten für veraltete Unterpfade, reservierte gebündelte Hilfsfunktionen, unterstützte gebündelte Fassaden und Plugin-eigene öffentliche Oberflächen.
Maintainer prüfen die Anzahl öffentlicher Exporte mit pnpm plugin-sdk:surface und aktive reservierte Hilfsfunktions-Unterpfade mit pnpm plugins:boundary-report:summary; ungenutzte reservierte Hilfsfunktionsexporte lassen den CI-Bericht fehlschlagen, statt als inaktive Kompatibilitätsschuld im öffentlichen SDK zu verbleiben. Den Leitfaden zur Plugin-Erstellung finden Sie unter Plugin-SDK-Übersicht.

Plugin-Einstieg

Kompatibilität und private-lokale Hilfsfunktionen

Nur die in einem späteren Zeitfenster veralteten Unterpfade bleiben exportiert. Aliasse vom Juli 2026 und ungenutzte Unterpfade wurden gelöscht, während ausschließlich gebündelte Hilfsfunktionen aus dem öffentlichen Paket entfernt wurden und nachfolgend als private-lokal gekennzeichnet sind. Die gepflegte Liste ist scripts/lib/plugin-sdk-deprecated-public-subpaths.json; die CI weist gebündelte plugin-sdk/text-runtime zurück, die nur der Kompatibilität dienen, und plugin-sdk/zod ist ein Kompatibilitäts-Reexport: Importieren Sie zod direkt aus zod. Die breiten Domänen- Barrels plugin-sdk/agent-runtime, plugin-sdk/channel-lifecycle, plugin-sdk/conversation-runtime, plugin-sdk/hook-runtime, plugin-sdk/media-runtime, plugin-sdk/plugin-runtime und plugin-sdk/security-runtime sind ebenfalls zugunsten fokussierter Unterpfade veraltet. Die Vitest-basierten Testhilfs-Unterpfade von OpenClaw sind ausschließlich repository-lokal und werden nicht mehr als Paketexporte bereitgestellt: agent-runtime-test-contracts, channel-contract-testing, channel-target-testing, channel-test-helpers, plugin-state-test-runtime, plugin-test-api, plugin-test-contracts, plugin-test-runtime, provider-http-test-mocks, provider-test-contracts, reply-payload-testing, sqlite-runtime-testing, test-env, test-fixtures, test-live, test-live-auth, test-media-generation, test-media-understanding, test-node-mocks und testing. Die privaten gebündelten Hilfsoberflächen ssrf-runtime-internal und codex-native-task-runtime sind ebenfalls ausschließlich repository-lokal.

Hilfs-Unterpfade gebündelter Plugins

Ausschließlich gebündelte Hilfsmodule sind seit der Bereinigung im Juli 2026 private-lokal. Eigentümerübergreifende Importe werden durch Schutzmechanismen des Paketvertrags blockiert. src/plugin-sdk/entrypoints.ts erfasst separat die unterstützten gebündelten Fassaden, die öffentlich bleiben, also SDK- Einstiegspunkte, die von ihrem gebündelten Plugin unterstützt werden, bis generische Verträge plugin-sdk/qa-runner-runtime, plugin-sdk/telegram-account ersetzen, für neuen Code veraltet; beachten Sie die Hinweise in den jeweiligen Zeilen unten.
Kanal-Kompatibilitäts-Unterpfade aus späteren Zeitfenstern bleiben nur bis zu ihren Registry-Daten öffentlich. Juli-Aliasse wie direkter DM-Zugriff, Antwortoptionen, Kopplungs- pfade und abgespaltene Kanallaufzeiten wurden entfernt; ausschließlich gebündelte Hilfsfunktionen sind private-lokal.
Provider-Nutzungsmomentaufnahmen melden normalerweise ein oder mehrere Kontingent-windows, jeweils mit einer Bezeichnung, dem verwendeten Prozentsatz und einer optionalen Rücksetzzeit. Provider, die anstelle zurücksetzbarer Kontingentfenster einen Saldo- oder Kontostatus-Text bereitstellen, sollten summary mit einem leeren windows-Array zurückgeben, statt Prozentsätze zu erfinden. OpenClaw zeigt diesen Zusammenfassungstext in der Statusausgabe an; verwenden Sie error nur, wenn der Nutzungsendpunkt fehlgeschlagen ist oder keine nutzbaren Nutzungsdaten zurückgegeben hat.
Reservierte SDK-Unterpfade für gebündelte Hilfsfunktionen sind eng begrenzte, inhaberspezifische Oberflächen für gebündelten Plugin-Code. Sie werden im SDK-Inventar erfasst, damit Paket- Builds und Aliasing deterministisch bleiben, sind jedoch keine allgemeinen APIs für die Plugin-Entwicklung. Neue wiederverwendbare Host-Verträge sollten generische SDK-Unterpfade wie plugin-sdk/gateway-runtime und plugin-sdk/ssrf-runtime verwenden.

Verwandte Themen