Skip to main content
Le SDK de Plugin est exposé sous la forme d’un ensemble de sous-chemins publics ciblés sous openclaw/plugin-sdk/. Cette page répertorie les sous-chemins couramment utilisés, regroupés par fonction. Trois fichiers définissent la surface :
  • scripts/lib/plugin-sdk-entrypoints.json : l’inventaire maintenu des points d’entrée que la compilation compile.
  • scripts/lib/plugin-sdk-private-local-only-subpaths.json : les sous-chemins de test/internes propres au dépôt. Les exportations du paquet correspondent à l’inventaire moins cette liste.
  • src/plugin-sdk/entrypoints.ts : les métadonnées de classification des sous-chemins obsolètes, des assistants groupés réservés, des façades groupées prises en charge et des surfaces publiques appartenant aux plugins.
Les mainteneurs auditent le nombre d’exportations publiques avec pnpm plugin-sdk:surface et les sous-chemins actifs des assistants réservés avec pnpm plugins:boundary-report:summary ; les exportations inutilisées d’assistants réservés font échouer le rapport de CI au lieu de rester dans le SDK public comme dette de compatibilité dormante. Pour le guide de création de plugins, consultez Présentation du SDK de Plugin.

Point d’entrée du Plugin

Assistants de compatibilité et de test obsolètes

Les sous-chemins obsolètes restent exportés pour les anciens plugins, mais le nouveau code doit utiliser les sous-chemins ciblés du SDK ci-dessous. La liste maintenue est scripts/lib/plugin-sdk-deprecated-public-subpaths.json ; la CI rejette les importations de production groupées provenant de cette liste. Les barils généraux tels que plugin-sdk/compat, plugin-sdk/config-types, plugin-sdk/infra-runtime et plugin-sdk/text-runtime servent uniquement à la compatibilité, et plugin-sdk/zod est une réexportation de compatibilité : importez zod directement depuis zod. Les barils généraux de domaine plugin-sdk/agent-runtime, plugin-sdk/channel-lifecycle, plugin-sdk/channel-runtime, plugin-sdk/cli-runtime, plugin-sdk/conversation-runtime, plugin-sdk/hook-runtime, plugin-sdk/media-runtime, plugin-sdk/plugin-runtime et plugin-sdk/security-runtime sont également obsolètes au profit de sous-chemins ciblés. Les sous-chemins des assistants de test d’OpenClaw basés sur Vitest sont réservés au dépôt et ne sont plus exportés par le paquet : 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-node-mocks et testing. Les surfaces privées des assistants groupés ssrf-runtime-internal et codex-native-task-runtime sont également réservées au dépôt.

Sous-chemins réservés des assistants de plugins groupés

plugin-sdk/codex-mcp-projection est le seul sous-chemin réservé : une surface de compatibilité appartenant au Plugin pour le Plugin Codex groupé, et non une API générale du SDK. Les importations de plugins entre propriétaires sont bloquées par les garde-fous du contrat du paquet, et la CI échoue lorsqu’un sous-chemin réservé cesse d’être importé. plugin-sdk/codex-native-task-runtime est réservé au dépôt et n’est pas une exportation du paquet. src/plugin-sdk/entrypoints.ts répertorie également les façades groupées prises en charge, des points d’entrée du SDK soutenus par leur Plugin groupé jusqu’à ce que des contrats génériques les remplacent : plugin-sdk/discord, plugin-sdk/lmstudio, plugin-sdk/lmstudio-runtime, plugin-sdk/matrix, plugin-sdk/mattermost, plugin-sdk/memory-core-engine-runtime, plugin-sdk/provider-zai-endpoint, plugin-sdk/qa-runner-runtime, plugin-sdk/telegram-account, plugin-sdk/tts-runtime et plugin-sdk/zalouser. Plusieurs d’entre eux sont également obsolètes pour le nouveau code ; consultez les notes de chaque ligne ci-dessous.
Les familles obsolètes d’utilitaires de canal restent disponibles uniquement pour assurer la compatibilité des plugins publiés. Le plan de suppression est le suivant : les conserver pendant la période de migration des plugins externes, maintenir les plugins du dépôt/intégrés sur channel-inbound et channel-outbound, puis supprimer les sous-chemins de compatibilité lors du prochain nettoyage majeur du SDK. Cela s’applique aux anciennes familles de messages et d’environnement d’exécution des canaux, de diffusion en continu des canaux, d’accès aux messages directs, de fragments d’utilitaires entrants, d’options de réponse et de chemins d’appairage.
Les instantanés d’utilisation des fournisseurs indiquent normalement un ou plusieurs windows de quota, chacun avec un libellé, un pourcentage utilisé et une heure facultative de réinitialisation. Les fournisseurs qui exposent un solde ou un texte d’état du compte au lieu de fenêtres de quota réinitialisables doivent renvoyer summary avec un tableau windows vide plutôt que d’inventer des pourcentages. OpenClaw affiche ce texte récapitulatif dans la sortie d’état ; utilisez error uniquement lorsque le point de terminaison d’utilisation a échoué ou n’a renvoyé aucune donnée d’utilisation exploitable.
Les sous-chemins du SDK réservés aux assistants intégrés sont des surfaces ciblées et propres à leur propriétaire pour le code des plugins intégrés. Ils sont suivis dans l’inventaire du SDK afin que les builds de packages et la gestion des alias restent déterministes, mais ne constituent pas des API générales de création de plugins. Les nouveaux contrats hôtes réutilisables doivent utiliser des sous-chemins génériques du SDK tels que plugin-sdk/gateway-runtime, plugin-sdk/ssrf-runtime et plugin-sdk/plugin-config-runtime.

Voir aussi