Sous-chemins du SDK de plugin
Le plugin SDK est exposé sous la forme d’un ensemble de sous-chemins publics étroits sous openclaw/plugin-sdk/. Cette page répertorie les sous-chemins couramment utilisés regroupés par objectif. L’inventaire généré des points d’entrée du compilateur se trouve dans scripts/lib/plugin-sdk-entrypoints.json ; les exportations de paquets sont le sous-ensemble public après soustraction des sous-chemins de test/interne locaux au dépôt répertoriés dans scripts/lib/plugin-sdk-private-local-only-subpaths.json. Les mainteneurs peuvent auditer le nombre d’exportations publiques avec pnpm plugin-sdk:surface et les sous-chemins d’assistants réservés actifs avec pnpm plugins:boundary-report:summary ; les exportations d’assistants réservés inutilisés font échouer le rapport CI au lieu de rester dans le SDK public en tant que dette de compatibilité dormante.
Pour le guide de création de plugins, voir Vue d’ensemble du SDK de plugin.
Point d’entrée du plugin
Section intitulée « Point d’entrée du plugin »| Sous-chemin | Exports clés |
|---|---|
plugin-sdk/plugin-entry | definePluginEntry |
plugin-sdk/core | defineChannelPluginEntry, createChatChannelPlugin, createChannelPluginBase, defineSetupPluginEntry, buildChannelConfigSchema, buildJsonChannelConfigSchema |
plugin-sdk/config-schema | OpenClawSchema |
plugin-sdk/provider-entry | defineSingleProviderPluginEntry |
plugin-sdk/migration | Assistants d’éléments de fournisseur de migration tels que createMigrationItem, des constantes de raison, des marqueurs de statut d’élément, des assistants de rédaction, et summarizeMigrationItems |
plugin-sdk/migration-runtime | Assistants de migration d’exécution tels que copyMigrationFileItem, withCachedMigrationConfigRuntime et writeMigrationReport |
Assistants de compatibilité et de test obsolètes
Section intitulée « Assistants de compatibilité et de test obsolètes »Ces sous-chemins restent des exportations de package pour les plugins plus anciens et les suites de tests OpenClaw,
mais le nouveau code ne doit pas ajouter d’imports depuis eux : agent-runtime-test-contracts,
channel-contract-testing, channel-target-testing, channel-test-helpers,
plugin-test-api, plugin-test-contracts, provider-http-test-mocks,
provider-test-contracts, test-env, test-fixtures, test-node-mocks,
testing, channel-runtime, compat, config-types, infra-runtime,
text-runtime, et zod. Importez zod directement depuis zod dans le nouveau code de plugin.
plugin-test-runtime est toujours un sous-chemin d’assistant de test ciblé actif.
Sous-chemins d’assistants de plugins groupés réservés
Section intitulée « Sous-chemins d’assistants de plugins groupés réservés »Ces sous-chemins sont des surfaces de compatibilité appartenant aux plugins, réservées pour leur plugin groupé propriétaire,
et non des API SDK générales : plugin-sdk/codex-mcp-projection et
plugin-sdk/codex-native-task-runtime. Les imports d’extensions inter-propriétaires sont bloqués
par les garde-fous du contrat de package.
Sous-chemins publics inutilisés obsolètes
Section intitulée « Sous-chemins publics inutilisés obsolètes »Ces sous-chemins publics existent depuis au moins un mois et n’ont actuellement aucune importation de production d’extension groupée. Ils restent importables pour des raisons de compatibilité, mais le nouveau code de plugin devrait plutôt utiliser des sous-chemins du SDK ciblés et activement consommés : agent-config-primitives, channel-config-schema-legacy, channel-reply-pipeline, channel-runtime, channel-secret-runtime, command-auth, compat, config-runtime, config-schema, discord, group-access, infra-runtime, matrix, mattermost, media-generation-runtime-shared, memory-core-engine-runtime, memory-core-host-multimodal, memory-core-host-query, music-generation-core, self-hosted-provider-setup, telegram-account, telegram-command-config et zalouser.
Sous-chemins publics rares obsolètes
Section intitulée « Sous-chemins publics rares obsolètes »Les sous-chemins publics actuellement utilisés par un ou deux propriétaires de plugin groupé sont également obsolètes pour le nouveau code de plugin. Ils restent des exportations de package pour la compatibilité, mais le nouveau code devrait préférer les interfaces du SDK partagées activement ou les API de packages appartenant aux plugins. Les mainteneurs suivent l’ensemble exact dans scripts/lib/plugin-sdk-deprecated-public-subpaths.json et le budget actuel avec pnpm plugin-sdk:surface.
Barils larges obsolètes
Section intitulée « Barils larges obsolètes »Ces barils de ré-exportation larges restent constructibles pour la source OpenClaw et les vérifications de compatibilité, mais le nouveau code devrait privilégier des sous-chemins SDK ciblés : agent-runtime, channel-lifecycle, channel-runtime, cli-runtime, compat, config-types, conversation-runtime, hook-runtime, infra-runtime, media-runtime, plugin-runtime, security-runtime et text-runtime. channel-runtime, compat, config-types, infra-runtime et text-runtime restent des exportations de package uniquement pour la rétrocompatibilité ; utilisez plutôt des sous-chemins channel/runtime ciblés, config-contracts, string-coerce-runtime, text-chunking, text-utility-runtime et logging-core.
Sous-chemins de channel
| Sous-chemin | Exportations clés |
|---|---|
plugin-sdk/channel-core | defineChannelPluginEntry, defineSetupPluginEntry, createChatChannelPlugin, createChannelPluginBase |
plugin-sdk/config-schema | Exportation du schéma Zod openclaw.json racine (OpenClawSchema) |
plugin-sdk/json-schema-runtime | Helper de validation JSON Schema mis en cache pour les schémas appartenant au plugin |
plugin-sdk/channel-setup | createOptionalChannelSetupSurface, createOptionalChannelSetupAdapter, createOptionalChannelSetupWizard, plus DEFAULT_ACCOUNT_ID, createTopLevelChannelDmPolicy, setSetupChannelEnabled, splitSetupEntries |
plugin-sdk/setup | Helpers partagés de l’assistant de configuration, traducteur de configuration, invites de liste blanche, constructeurs de statut de configuration |
plugin-sdk/setup-runtime | createSetupTranslator, createPatchedAccountSetupAdapter, createEnvPatchedAccountSetupAdapter, createSetupInputPresenceValidator, noteChannelLookupFailure, noteChannelLookupSummary, promptResolvedAllowFrom, splitSetupEntries, createAllowlistSetupWizardProxy, createDelegatedSetupWizardProxy |
plugin-sdk/setup-adapter-runtime | Alias de compatibilité obsolète ; utilisez plugin-sdk/setup-runtime |
plugin-sdk/setup-tools | formatCliCommand, detectBinary, extractArchive, resolveBrewExecutable, formatDocsLink, CONFIG_DIR |
plugin-sdk/account-core | Helpers de configuration/action-gate multi-compte, helpers de repli du compte par défaut |
plugin-sdk/account-id | DEFAULT_ACCOUNT_ID, helpers de normalisation de l’ID de compte |
plugin-sdk/account-resolution | Helpers de recherche de compte + repli par défaut |
plugin-sdk/account-helpers | Helpers de liste de comptes/actions de compte étroits |
plugin-sdk/access-groups | Helpers d’analyse de la liste blanche des groupes d’accès et de diagnostic de groupe expurgé |
plugin-sdk/channel-pairing | createChannelPairingController |
plugin-sdk/channel-reply-pipeline | Helpers de pipeline de réponse hérités. Le nouveau code de pipeline de réponse de channel doit utiliser createChannelMessageReplyPipeline et resolveChannelMessageSourceReplyDeliveryMode de plugin-sdk/channel-message. |
plugin-sdk/channel-config-helpers | createHybridChannelConfigAdapter, resolveChannelDmAccess, resolveChannelDmAllowFrom, resolveChannelDmPolicy, normalizeChannelDmPolicy, normalizeLegacyDmAliases |
plugin-sdk/channel-config-schemaTypeBox | Primitives de schéma de configuration de channel partagé plus les constructeurs Zod et JSON/TypeBox directs |
plugin-sdk/bundled-channel-config-schema | Schémas de configuration de channel OpenClaw groupés pour les plugins groupés maintenus uniquement |
plugin-sdk/channel-config-schema-legacy | Alias de compatibilité obsolète pour les schémas de configuration de channel groupés |
plugin-sdk/telegram-command-config | Helpers de normalisation/validation de commande personnalisée Telegram avec repli vers le contrat groupé |
plugin-sdk/command-gating | Helpers étroits de porte d’autorisation de commande |
plugin-sdk/channel-policy | resolveChannelGroupRequireMention |
plugin-sdk/channel-ingress | Façade de compatibilité d’entrée de channel de bas niveau obsolète. Les nouveaux chemins de réception doivent utiliser plugin-sdk/channel-ingress-runtime. |
plugin-sdk/channel-ingress-runtime | Résolveur d’exécution d’entrée de channel de haut niveau expérimental et constructeurs de faits de routage pour les chemins de réception de channel migrés. Préférez ceci plutôt que d’assembler des listes blanches effectives, des listes blanches de commandes et des projections héritées dans chaque plugin. Voir Channel ingress API. |
plugin-sdk/channel-lifecycle | createAccountStatusSink, createChannelRunQueue et helpers de cycle de vie de flux de brouillon hérités. Le nouveau code de finalisation de l’aperçu doit utiliser plugin-sdk/channel-message. |
plugin-sdk/channel-message | Helpers de contrat de cycle de vie de message bon marché tels que defineChannelMessageAdapter, createChannelMessageAdapterFromOutbound, createChannelMessageReplyPipeline, createReplyPrefixContext, resolveChannelMessageSourceReplyDeliveryMode, dérivation de capacité durable-final, helpers de preuve de capacité pour les capacités d’envoi/réception/effet secondaire, MessageReceiveContext, preuves de politique d’accusé de réception de réception, defineFinalizableLivePreviewAdapter, deliverWithFinalizableLivePreviewAdapter, preuves de capacité d’aperçu en direct et de finaliseur en direct, état de récupération durable, RenderedMessageBatch, types de réception de message et helpers d’ID de réception. Voir Channel message API. Les façades de répartition de réponse héritées sont obsolètes uniquement pour la compatibilité. |
plugin-sdk/channel-message-runtime | Helpers de livraison d’exécution qui peuvent charger la livraison sortante, y compris deliverInboundReplyWithMessageSendContext, sendDurableMessageBatch et withDurableMessageSendContext. Les ponts de répartition de réponse obsolètes restent importables uniquement pour les répartiteurs de compatibilité. À utiliser à partir des modules d’exécution de surveillance/envoi, et non des fichiers d’amorçage de plugin à chaud. |
plugin-sdk/inbound-envelope | Helpers partagés de construction de route entrante + d’enveloppe |
plugin-sdk/inbound-reply-dispatch | Helpers partagés hérités d’enregistrement et de répartition entrants, prédicats de répartition visible/finale et compatibilité obsolète deliverDurableInboundReplyPayload pour les répartiteurs de channel préparés. Le nouveau code de répartition/réception de channel doit importer les helpers de cycle de vie d’exécution à partir de plugin-sdk/channel-message-runtime. |
plugin-sdk/messaging-targets | Helpers d’analyse/correspondance de cible |
plugin-sdk/outbound-media | Helpers partagés de chargement de média sortant |
plugin-sdk/outbound-send-deps | Recherche de dépendance d’envoi sortant légère pour les adaptateurs de channel |
plugin-sdk/outbound-runtime | Helpers d’identité sortante, de délégué d’envoi, de session, de formatage et de planification de charge utile. Les helpers de livraison directe tels que deliverOutboundPayloads sont un substrat de compatibilité obsolète ; utilisez plugin-sdk/channel-message-runtime pour les nouveaux chemins d’envoi. |
plugin-sdk/poll-runtime | Helpers étroits de normalisation des sondages |
plugin-sdk/thread-bindings-runtime | Helpers de cycle de vie et d’adaptateur de liaison de thread |
plugin-sdk/agent-media-payload | Constructeur de charge utile média d’agent hérité |
plugin-sdk/conversation-runtime | Helpers de liaison de conversation/thread, d’appariement et de liaison configurée |
plugin-sdk/runtime-config-snapshot | Helper d’instantané de configuration d’exécution |
plugin-sdk/runtime-group-policy | Helpers de résolution de stratégie de groupe d’exécution |
plugin-sdk/channel-status | Helpers partagés d’instantané/résumé de statut de channel |
plugin-sdk/channel-config-primitives | Primitives étroites de schéma de configuration de channel |
plugin-sdk/channel-config-writes | Helpers d’autorisation d’écriture de configuration de channel |
plugin-sdk/channel-plugin-common | Exportations de prélude de plugin de channel partagé |
plugin-sdk/allowlist-config-edit | Helpers de modification/lecture de configuration de liste blanche |
plugin-sdk/group-access | Helpers partagés de décision d’accès au groupe |
plugin-sdk/direct-dm | Helpers partagés d’authentification/garde de DM direct |
plugin-sdk/discord | Façade de compatibilité Discord obsolète pour @openclaw/[email protected] publiés et compatibilité du propriétaire suivie ; les nouveaux plugins doivent utiliser les sous-chemins SDK de channel génériques |
plugin-sdk/telegram-account | Façade de compatibilité de résolution de compte Telegram obsolète pour la compatibilité du propriétaire suivie ; les nouveaux plugins doivent utiliser les helpers d’exécution injectés ou les sous-chemins SDK de channel génériques |
plugin-sdk/zalouser | Façade de compatibilité Zalo Personal obsolète pour les packages Lark/Zalo publiés qui importent encore l’autorisation de commande de l’expéditeur ; les nouveaux plugins doivent utiliser plugin-sdk/command-auth |
plugin-sdk/interactive-runtime | Présentation sémantique des messages, livraison et helpers de réponse interactive hérités. Voir Message Presentation |
plugin-sdk/channel-inbound | Helpers entrants partagés pour la classification des événements, la construction du contexte, le debounce, la correspondance des mentions, la politique de mention et le formatage de l’enveloppe |
plugin-sdk/channel-inbound-debounce | Helpers étroits de debounce entrant |
plugin-sdk/channel-mention-gating | Helpers étroits de politique de mention, de marqueur de mention et de texte de mention sans la surface d’exécution entrante plus large |
plugin-sdk/channel-envelope | Helpers étroits de formatage d’enveloppe entrante |
plugin-sdk/channel-location | Helpers de contexte et de formatage de l’emplacement du channel |
plugin-sdk/channel-logging | Helpers de journalisation de channel pour les abandons entrants et les échecs de frappe/accusé de réception |
plugin-sdk/channel-send-result | Types de résultats de réponse |
plugin-sdk/channel-actions | Helpers d’action de message de channel, plus les helpers de schéma natif obsolètes conservés pour la compatibilité des plugins |
plugin-sdk/channel-route | Normalisation de route partagée, résolution de cible pilotée par l’analyseur, transformation de l’ID de thread en chaîne, clés de route dédupliquées/compactées, types de cible analysée et helpers de comparaison de route/cible |
plugin-sdk/channel-targets | Helpers d’analyse de cible ; les appelants de comparaison de route doivent utiliser plugin-sdk/channel-route |
plugin-sdk/channel-contract | Types de contrat de channel |
plugin-sdk/channel-feedback | Câblage des commentaires/réactions |
plugin-sdk/channel-secret-runtime | Helpers étroits de contrat secret tels que collectSimpleChannelFieldAssignments, getChannelSurface, pushAssignment et les types de cibles secrètes |
Provider subpaths
| Sous-chemin | Exportations clés | | --- | --- | | plugin-sdk/provider-entry | defineSingleProviderPluginEntry | | plugin-sdk/lmstudio | Façade de fournisseur LM Studio prise en charge pour la configuration, la découverte du catalogue et la préparation du modèle à l’exécution | | plugin-sdk/lmstudio-runtime | Façade d’exécution LM Studio prise en charge pour les défauts du serveur
local, la découverte de modèles, les en-têtes de requête et les assistants de modèles chargés | | plugin-sdk/provider-setup | Assistants de configuration de fournisseur local/auto-hébergé sélectionnés | | plugin-sdk/self-hosted-provider-setup | Assistants de configuration de fournisseur auto-hébergé compatible OpenAI ciblés | | plugin-sdk/cli-backend | Défauts du backend CLI + constantes
de chien de garde | | plugin-sdk/provider-auth-runtime | Assistants de résolution de clé API à l’exécution pour les plugins de fournisseur | | plugin-sdk/provider-auth-api-key | Assistants d’intégration/écriture de profil de clé API tels que upsertApiKeyProfile | | plugin-sdk/provider-auth-result | Générateur de résultats d’authentification OAuth standard | |
plugin-sdk/provider-env-vars | Assistants de recherche de variables d’environnement d’authentification de fournisseur | | plugin-sdk/provider-auth | createProviderApiKeyAuthMethod, ensureApiKeyFromOptionEnvOrPrompt, upsertAuthProfile, upsertApiKeyProfile, writeOAuthCredentials, exportation de compatibilité resolveOpenClawAgentDir obsolète | | plugin-sdk/provider-model-shared |
ProviderReplayFamily, buildProviderReplayFamilyHooks, normalizeModelCompat, générateurs de stratégies de relecture partagés, assistants de point de terminaison de fournisseur et assistants de normalisation d’ID de modèle partagés | | plugin-sdk/provider-catalog-runtime | Hook d’exécution d’augmentation de catalogue de fournisseur et points de suture de registre de fournisseur de plugin
pour les tests contractuels | | plugin-sdk/provider-catalog-shared | findCatalogTemplate, buildSingleProviderApiKeyCatalog, buildManifestModelProviderConfig, supportsNativeStreamingUsageCompat, applyProviderNativeStreamingUsageCompat | | plugin-sdk/provider-http | Assistants de capacités HTTP/point de terminaison de fournisseur génériques, erreurs HTTP de fournisseur et assistants
de formulaire multipart pour la transcription audio | | plugin-sdk/provider-web-fetch-contract | Assistants de contrat de configuration/sélection de récupération Web étroits tels que enablePluginInConfig et WebFetchProviderPlugin | | plugin-sdk/provider-web-fetch | Assistants d’enregistrement/cache de fournisseur de récupération Web | | plugin-sdk/provider-web-search-config-contract |
Assistants de configuration/identifiants de recherche Web étroits pour les fournisseurs qui n’ont pas besoin du câblage d’activation de plugin | | plugin-sdk/provider-web-search-contract | Assistants de contrat de configuration/identifiants de recherche Web étroits tels que createWebSearchProviderContractFields, enablePluginInConfig, resolveProviderWebSearchPluginConfig, et
setters/getters d’identifiants délimités | | plugin-sdk/provider-web-search | Assistants d’enregistrement/cache/exécution de fournisseur de recherche Web | | plugin-sdk/provider-tools | ProviderToolCompatFamily, buildProviderToolCompatFamilyHooks, et nettoyage + diagnostics de schéma DeepSeek/Gemini/OpenAI | | plugin-sdk/provider-usage | fetchClaudeUsage et similaires | |
plugin-sdk/provider-stream | ProviderStreamFamily, buildProviderStreamFamilyHooks, composeProviderStreamWrappers, types de wrapper de flux et assistants de wrapper partagés Anthropic/Bedrock/DeepSeek V4/Google/Kilocode/Moonshot/OpenAI/OpenRouter/Z.A.I/MiniMax/Copilot | | plugin-sdk/provider-transport-runtime | Assistants de transport de fournisseur natif tels que la récupération
protégée, les transformations de messages de transport et les flux d’événements de transport inscriptibles | | plugin-sdk/provider-onboard | Assistants de correctif de configuration d’intégration | | plugin-sdk/global-singleton | Assistants de singleton/map/cache locaux au processus | | plugin-sdk/group-activation | Assistants d’analyse de commande et de mode d’activation de groupe étroit
|
Sous-chemins d'authentification et de sécurité
| Sous-chemin | Exportations clés | | --- | --- | | plugin-sdk/command-auth | resolveControlCommandGate, aides au registre de commandes, y compris le formatage dynamique des menus d’arguments et les aides à l’autorisation de l’expéditeur | | plugin-sdk/command-status | Générateurs de messages d’aide/de commandes tels que buildCommandsMessagePaginated et buildHelpMessage | |
plugin-sdk/approval-auth-runtime | Aides à la résolution de l’approbateur et à l’authentification des actions du même chat | | plugin-sdk/approval-client-runtime | Aides au profil/filtre d’approbation d’exécution native | | plugin-sdk/approval-delivery-runtime | Adaptateurs de capacité/livraison d’approbation native | | plugin-sdk/approval-gateway-runtime | Aide partagée à la résolution
de la passerelle d’approbation | | plugin-sdk/approval-handler-adapter-runtime | Aides légères au chargement de l’adaptateur d’approbation native pour les points d’entrée de canal à chaud | | plugin-sdk/approval-handler-runtime | Aides d’exécution plus larges du gestionnaire d’approbation ; préférez les interfaces plus étroites de l’adaptateur/de la passerelle lorsqu’elles suffisent | |
plugin-sdk/approval-native-runtime | Aides à la cible d’approbation native + liaison de compte | | plugin-sdk/approval-reply-runtime | Aides à la charge utile de réponse d’approbation d’exécution/plugin | | plugin-sdk/approval-runtime | Aides à la charge utile d’approbation d’exécution/plugin, aides au routage/exécution d’approbation native et aides à l’affichage structuré des approbations
telles que formatApprovalDisplayPath | | plugin-sdk/reply-dedupe | Aides étroites à la réinitialisation de la déduplication des réponses entrantes | | plugin-sdk/channel-contract-testing | Aides étroites aux tests de contrat de canal sans le baril de test large | | plugin-sdk/command-auth-native | Aides à l’authentification des commandes natives, au formatage dynamique des menus
d’arguments et aux aides aux cibles de session natives | | plugin-sdk/command-detection | Aides partagées à la détection des commandes | | plugin-sdk/command-primitives-runtime | Prédicats de texte de commande légers pour les chemins de canal à chaud | | plugin-sdk/command-surface | Aides à la normalisation du corps de commande et à la surface de commande | | plugin-sdk/allow-from |
formatAllowFromLowercase | | plugin-sdk/channel-secret-runtime | Aides étroites à la collection de contrats de secrets pour les surfaces de secrets de canal/plugin | | plugin-sdk/secret-ref-runtime | Aides étroites de coerceSecretRef et de SecretRef pour l’analyse de contrat de secret/de configuration | | plugin-sdk/security-runtime | Aides partagées de confiance, de restriction de DM,
de fichiers/chemins délimités à la racine, y compris les écritures en création seule, le remplacement de fichier atomique synchrone/asynchrone, les écritures temporaires frères, le repli de déplacement entre appareils, les aides au stockage de fichiers privés, les gardiens de parents de liens symboliques, le contenu externe, la suppression de texte sensible, la comparaison de secrets à temps
constant et les aides à la collection de secrets | | plugin-sdk/ssrf-policy | Aides à la stratégie de liste d’autorisation d’hôte et de SSRF de réseau privé | | plugin-sdk/ssrf-dispatcher | Aides étroites au répartiteur épinglé sans la surface d’exécution d’infra large | | plugin-sdk/ssrf-runtime | Répartiteur épinglé, récupération protégée contre les SSRF, erreur SSRF et aides à la
stratégie SSRF | | plugin-sdk/secret-input | Aides à l’analyse de l’entrée secrète | | plugin-sdk/webhook-ingress | Aides à la requête/cible de webhook et contrainte websocket/corps brute | | plugin-sdk/webhook-request-guards | Aides à la taille/délai d’attente du corps de la requête |
Sous-chemins d'exécution et de stockage
| Sous-chemin | Principales exportations | | --- | --- | | plugin-sdk/runtime | Assistants larges pour l’exécution/journalisation/sauvegarde/installation de plugin | | plugin-sdk/runtime-env | Assistants étroits pour l’environnement d’exécution, le journal, le délai d’attente, la nouvelle tentative et l’attente exponentielle | | plugin-sdk/browser-config | Façade de configuration de
navigateur prise en charge pour les profils/paramètres par défaut normalisés, l’analyse d’URL CDP et les assistants d’authentification de contrôle de navigateur | | plugin-sdk/codex-mcp-projection | Assistant Codex groupé réservé pour projeter la configuration du serveur MCP de l’utilisateur dans la configuration de fil Codex ; non destiné aux plugins tiers | |
plugin-sdk/codex-native-task-runtime | Assistant Codex groupé réservé pour le câblage natif de miroir/d’exécution des tâches ; non destiné aux plugins tiers | | plugin-sdk/channel-runtime-context | Assistants génériques d’enregistrement et de recherche de contexte d’exécution de channel | | plugin-sdk/matrix | Façade de compatibilité Matrix obsolète pour les anciens packages de channel
tiers ; les nouveaux plugins doivent importer plugin-sdk/run-command directement | | plugin-sdk/mattermost | Façade de compatibilité Mattermost obsolète pour les anciens packages de channel tiers ; les nouveaux plugins doivent importer les sous-chemins génériques du SDK directement | | plugin-sdk/runtime-store | createPluginRuntimeStore | | plugin-sdk/plugin-runtime | Assistants
partagés pour les commandes/hooks/http/interactifs de plugin | | plugin-sdk/hook-runtime | Assistants partagés pour le pipeline de webhook/hook interne | | plugin-sdk/lazy-runtime | Assistants paresseux d’importation/de liaison d’exécution tels que createLazyRuntimeModule, createLazyRuntimeMethod et createLazyRuntimeSurface | | plugin-sdk/process-runtime | Assistants d’exécution de
processus | | plugin-sdk/cli-runtime | Assistants de formatage CLI, d’attente, de version, d’invocation d’arguments et de groupe de commandes paresseux | | plugin-sdk/gateway-method-runtime | Assistant de répartition de méthode Gateway réservé pour les routes HTTP de plugin qui déclarent contracts.gatewayMethodDispatch: ["authenticated-request"] | | plugin-sdk/gateway-runtime | Client
Gateway, assistant de démarrage de client prêt pour la boucle d’événements, CLI RPC de passerelle, erreurs de protocole de passerelle et assistants de correctifs d’état de channel | | plugin-sdk/config-contracts | Surface de configuration de types uniquement ciblée pour les formes de configuration de plugin telles que OpenClawConfig et les types de configuration de channel/provider | |
plugin-sdk/plugin-config-runtime | Assistants de recherche de configuration de plugin d’exécution tels que requireRuntimeConfig, resolvePluginConfigObject et resolveLivePluginConfigObject | | plugin-sdk/config-mutation | Assistants de mutation transactionnelle de configuration tels que mutateConfigFile, replaceConfigFile et logConfigUpdated | |
plugin-sdk/runtime-config-snapshot | Assistants de instantané de configuration du processus actuel tels que getRuntimeConfig, getRuntimeConfigSnapshot et les setters de instantané de test | | plugin-sdk/telegram-command-config | Normalisation du nom/de la description de commande Telegram et vérifications de doublons/conflits, même lorsque la surface de contrat Telegram groupée n’est pas
disponible | | plugin-sdk/text-autolink-runtime | Détection de lien automatique de référence de fichier sans le barrel de texte large | | plugin-sdk/approval-runtime | Assistants d’approbation d’exécution/plugin, générateurs de capacités d’approbation, assistants d’authentification/profil, assistants de routage/d’exécution natifs et formatage du chemin d’affichage structuré des approbations
| | plugin-sdk/reply-runtime | Assistants d’exécution entrants/de réponse partagés, découpage, répartition, battement de cœur, planificateur de réponse | | plugin-sdk/reply-dispatch-runtime | Assistants étroits de répartition/finalisation de réponse et d’étiquette de conversation | | plugin-sdk/reply-history | Assistants partagés d’historique de réponse à fenêtre courte. Le nouveau code de
tour de message doit utiliser createChannelHistoryWindow ; les assistants de map de niveau inférieur restent des exportations de compatibilité obsolètes uniquement | | plugin-sdk/reply-reference | createReplyReferencePlanner | | plugin-sdk/reply-chunking | Assistants étroits de découpage de texte/markdown | | plugin-sdk/session-store-runtime | Chemin de magasin de session, clé de
session, date de mise à jour et assistants de mutation de magasin | | plugin-sdk/cron-store-runtime | Assistants de chemin de chargement/sauvegarde de magasin Cron | | plugin-sdk/state-paths | Assistants de chemin de répertoire State/OAuth | | plugin-sdk/routing | Assistants de liaison route/clé de session/compte tels que resolveAgentRoute, buildAgentSessionKey et
resolveDefaultAgentBoundAccountId | | plugin-sdk/status-helpers | Assistants partagés de résumé d’état de channel/compte, valeurs par défaut d’état d’exécution et assistants de métadonnées de problème | | plugin-sdk/target-resolver-runtime | Assistants partagés de résolution de cible | | plugin-sdk/string-normalization-runtime | Assistants de normalisation de slug/chaîne | |
plugin-sdk/request-url | Extraire les URL de chaîne des entrées de type fetch/request | | plugin-sdk/run-command | Exécuteur de commande minuté avec résultats stdout/stderr normalisés | | plugin-sdk/param-readers | Lecteurs de paramètres tool/CLI courants | | plugin-sdk/tool-plugin | Définir un plugin d’agent-tool typé simple et exposer des métadonnées statiques pour la génération de
manifeste | | plugin-sdk/tool-payload | Extraire les charges utiles normalisées des objets de résultat d’outil | | plugin-sdk/tool-send | Extraire les champs de cible d’envoi canoniques des arguments d’outil | | plugin-sdk/temp-path | Assistants partagés de chemin de téléchargement temporaire et espaces de travail temporaires privés sécurisés | | plugin-sdk/logging-core | Journal de
sous-système et assistants de rédaction | | plugin-sdk/markdown-table-runtime | Assistants de mode et de conversion de tableau Markdown | | plugin-sdk/model-session-runtime | Assistants de substitution de modèle/session tels que applyModelOverrideToSessionEntry et resolveAgentMaxConcurrent | | plugin-sdk/talk-config-runtime | Assistants de résolution de configuration de provider Talk |
| plugin-sdk/json-store | Petits assistants de lecture/écriture d’état JSON | | plugin-sdk/file-lock | Assistants de verrouillage de fichier réentrant | | plugin-sdk/persistent-dedupe | Assistants de cache de déduplication sauvegardé sur disque | | plugin-sdk/acp-runtime | Assistants d’exécution/session ACP et de répartition de réponse | | plugin-sdk/acp-runtime-backend | Assistants
d’inscription de backend ACP léger et de répartition de réponse pour les plugins chargés au démarrage | | plugin-sdk/acp-binding-resolve-runtime | Résolution de liaison ACP en lecture seule sans importations de démarrage de cycle de vie | | plugin-sdk/agent-config-primitives | Primitives étroites de schéma de configuration d’exécution d’agent | | plugin-sdk/boolean-param | Lecteur de
paramètre booléen souple | | plugin-sdk/dangerous-name-runtime | Assistants de résolution de correspondance de nom dangereux | | plugin-sdk/device-bootstrap | Assistants de bootstrap d’appareil et de jeton d’appairage | | plugin-sdk/extension-shared | Primitives d’assistant partagées pour channel passif, l’état et le proxy ambiant | | plugin-sdk/models-provider-runtime | Assistants de
réponse de command/provider /models | | plugin-sdk/skill-commands-runtime | Assistants de liste de commandes Skill | | plugin-sdk/native-command-registry | Assistants de registre/construction/sérialisation de commandes natives | | plugin-sdk/agent-harness | Surface de plugin de confiance expérimentale pour des harnais d’agent de bas niveau : types de harnais, assistants de
guidage/abandon d’exécution active, assistants de pont d’outil OpenClaw, assistants de stratégie d’outil de plan d’exécution, classification des résultats terminaux, assistants de formatage/détail de progression d’outil et utilitaires de résultats de tentative | | plugin-sdk/provider-zai-endpoint | Façade de détection de point de terminaison détenue par le provider Z.AI obsolète ; utilisez
l’API publique du plugin Z.AI | | plugin-sdk/async-lock-runtime | Assistant de verrou asynchrone local au processus pour les petits fichiers d’état d’exécution | | plugin-sdk/channel-activity-runtime | Assistant de télémétrie d’activité de channel | | plugin-sdk/concurrency-runtime | Assistant de concurrence de tâches asynchrones bornée | | plugin-sdk/dedupe-runtime | Assistants de cache
de déduplication en mémoire | | plugin-sdk/delivery-queue-runtime | Assistant de drainage de livraison en attente sortante | | plugin-sdk/file-access-runtime | Assistants de chemin de fichier local et de source multimédia sûrs | | plugin-sdk/heartbeat-runtime | Assistants de réveil, d’événement et de visibilité du battement de cœur | | plugin-sdk/number-runtime | Assistant de coercition
numérique | | plugin-sdk/secure-random-runtime | Assistants de jeton/UUID sécurisés | | plugin-sdk/system-event-runtime | Assistants de file d’attente d’événements système | | plugin-sdk/transport-ready-runtime | Assistant d’attente de disponibilité du transport | | plugin-sdk/infra-runtime | Shim de compatibilité obsolète ; utilisez les sous-chemins d’exécution ciblés ci-dessus | |
plugin-sdk/collection-runtime | Petits assistants de cache borné | | plugin-sdk/diagnostic-runtime | Assistants de drapeau de diagnostic, d’événement et de contexte de traçage | | plugin-sdk/error-runtime | Graphe d’erreurs, formatage, assistants de classification d’erreurs partagés, isApprovalNotFoundError | | plugin-sdk/fetch-runtime | Fetch encapsulé, proxy, option EnvHttpProxyAgent
et assistants de recherche épinglée | | plugin-sdk/runtime-fetch | Fetch d’exécution conscient du répartiteur sans importations de proxy/fetch gardé | | plugin-sdk/response-limit-runtime | Lecteur de corps de réponse borné sans la surface d’exécution multimédia large | | plugin-sdk/session-binding-runtime | État de liaison de conversation actuel sans routage de liaison configuré ou
magasins d’appairage | | plugin-sdk/session-store-runtime | Assistants de magasin de session sans importations d’écriture/maintenance de configuration large | | plugin-sdk/context-visibility-runtime | Résolution de visibilité du contexte et filtrage du contexte supplémentaire sans importations de configuration/sécurité larges | | plugin-sdk/string-coerce-runtime | Assistants étroits de
coercition et de normalisation d’enregistrement/chaîne primitifs sans importations de markdown/journalisation | | plugin-sdk/host-runtime | Assistants de normalisation de nom d’hôte et d’hôte SCP | | plugin-sdk/retry-runtime | Assistants de configuration de nouvelle tentative et exécuteur de nouvelle tentative | | plugin-sdk/agent-runtime | Assistants de répertoire/identité/espace de
travail d’agent, y compris resolveAgentDir, resolveDefaultAgentDir et l’exportation de compatibilité obsolète resolveOpenClawAgentDir | | plugin-sdk/directory-runtime | Requête/dédup de répertoire sauvegardé par configuration | | plugin-sdk/keyed-async-queue | KeyedAsyncQueue |
Sous-chemins de capacité et de test
| Sous-chemin | Exportations clés | | --- | --- | | plugin-sdk/media-runtime | Assistants partagés de récupération/transformation/stockage de médias, y compris saveRemoteMedia, saveResponseMedia, readRemoteMediaBuffer et l’obsolète fetchRemoteMediaOpenClaw ; privilégiez les assistants de stockage avant les lectures de tampon lorsqu’une URL doit devenir un média OpenClaw | |
plugin-sdk/media-mime | Normalisation MIME étroite, mappage d’extension de fichier, détection MIME et assistants de type de média | | plugin-sdk/media-store | Assistants étroits de stockage de médias tels que saveMediaBuffer et saveMediaStream | | plugin-sdk/media-generation-runtime | Assistants partagés de basculement de génération de médias, de sélection de candidats et de messagerie
pour modèle manquant | | plugin-sdk/media-understanding | Types de fournisseurs de compréhension des médias plus exportations d’assistants d’extraction image/audio/structurée orientés fournisseur | | plugin-sdk/text-chunking | Assistants de découpage/rendu de texte et de markdown, conversion de tableaux markdown, suppression des balises de directive et utilitaires de texte sécurisé | |
plugin-sdk/text-chunking | Assistant de découpage de texte sortant | | plugin-sdk/speechOpenAI | Types de fournisseurs de synthèse vocale plus exportations d’assistants de directive, de registre, de validation, de constructeur TTS compatible OpenAI et de synthèse vocale orientés fournisseur | | plugin-sdk/speech-core | Types partagés de fournisseurs de synthèse vocale, registre, directive,
normalisation et exportations d’assistants de synthèse vocale | | plugin-sdk/realtime-transcription | Types de fournisseurs de transcription en temps réel, assistants de registre et assistant partagé de session WebSocket | | plugin-sdk/realtime-voice | Types de fournisseurs vocaux en temps réel et assistants de registre | | plugin-sdk/image-generationOpenAI | Types de fournisseurs de
génération d’images plus assistants d’URL de ressource/données d’image et le constructeur de fournisseur d’images compatible OpenAI | | plugin-sdk/image-generation-core | Types partagés de génération d’images, assistants de basculement, d’authentification et de registre | | plugin-sdk/music-generation | Types de fournisseur/demande/résultat de génération musicale | |
plugin-sdk/music-generation-core | Types partagés de génération musicale, assistants de basculement, recherche de fournisseur et analyse de référence de modèle | | plugin-sdk/video-generation | Types de fournisseur/demande/résultat de génération vidéo | | plugin-sdk/video-generation-core | Types partagés de génération vidéo, assistants de basculement, recherche de fournisseur et analyse de
référence de modèle | | plugin-sdk/webhook-targets | Registre de cibles Webhook et assistants d’installation de route | | plugin-sdk/webhook-path | Alias de compatibilité obsolète ; utilisez plugin-sdk/webhook-ingress | | plugin-sdk/web-media | Assistants partagés de chargement de médias distants/locaux | | plugin-sdk/zod | Ré-exportation de compatibilité obsolète ; importez zod
directement depuis zod | | plugin-sdk/testingOpenClaw | Baril de compatibilité obsolète local au dépôt pour les tests OpenClaw hérités. Les nouveaux tests du dépôt devraient plutôt importer des sous-chemins de test locaux ciblés tels que plugin-sdk/agent-runtime-test-contracts, plugin-sdk/plugin-test-runtime, plugin-sdk/channel-test-helpers, plugin-sdk/test-env ou
plugin-sdk/test-fixtures | | plugin-sdk/plugin-test-api | Assistant minimal createTestPluginApi local au dépôt pour les tests unitaires d’enregistrement direct de plugins sans importer de ponts d’assistants de test de dépôt | | plugin-sdk/agent-runtime-test-contracts | Fixtures de contrat d’adaptateur d’exécution d’agent natif local au dépôt pour les tests d’authentification, de
livraison, de basculement, de crochet d’outil, de superposition de prompt, de schéma et de projection de transcription | | plugin-sdk/channel-test-helpers | Assistants de test orientés canal locaux au dépôt pour les contrats d’actions/configuration/statut génériques, les assertions de répertoire, le cycle de vie de démarrage du compte, le threading de configuration d’envoi, les simulations
d’exécution, les problèmes de statut, la livraison sortante et l’enregistrement de crochets | | plugin-sdk/channel-target-testing | Suite de cas d’erreur de résolution de cible partagée locale au dépôt pour les tests de canal | | plugin-sdk/plugin-test-contractsAPI | Assistants de contrat de package de plugin, d’enregistrement, d’artefact public, d’import direct, d’API d’exécution et d’effet
secondaire d’importation locaux au dépôt | | plugin-sdk/provider-test-contracts | Assistants de contrat d’exécution, d’authentification, de découverte, d’intégration, de catalogue, d’assistant, de capacité média, de stratégie de relecture, d’audio en direct STT en temps réel, de recherche/récupération Web et de flux de fournisseur locaux au dépôt | | plugin-sdk/provider-http-test-mocks |
Simulations HTTP/auth Vitest optionnelles locales au dépôt pour les tests de fournisseurs qui exercent plugin-sdk/provider-http | | plugin-sdk/test-fixturesCLI | Fixtures génériques de capture d’exécution CLI, de contexte de bac à sable, de rédacteur de compétence, de message d’agent, d’événement système, de rechargement de module, de chemin de plugin groupé, de texte terminal, de découpage,
de jeton d’authentification et de cas typé locales au dépôt | | plugin-sdk/test-node-mocks | Assistants ciblés de simulation intégrée Node locaux au dépôt à utiliser dans les usines Vitest vi.mock("node:*") |
Sous-chemins de mémoire
| Sous-chemin | Exportations clés | | --- | --- | | plugin-sdk/memory-core | Surface d’assistance memory-core groupée pour les assistants de gestionnaire/configuration/fichier/CLI | | plugin-sdk/memory-core-engine-runtime | Façade d’exécution d’index/recherche de mémoire | | plugin-sdk/memory-core-host-engine-foundation | Exportations du moteur de base de l’hôte de mémoire | |
plugin-sdk/memory-core-host-engine-embeddings | Contrats d’intégration de l’hôte de mémoire, accès au registre, fournisseur local et assistants de lot génériques/distants | | plugin-sdk/memory-core-host-engine-qmd | Exportations du moteur QMD de l’hôte de mémoire | | plugin-sdk/memory-core-host-engine-storage | Exportations du moteur de stockage de l’hôte de mémoire | |
plugin-sdk/memory-core-host-multimodal | Assistants multimodaux de l’hôte de mémoire | | plugin-sdk/memory-core-host-query | Assistants de requête de l’hôte de mémoire | | plugin-sdk/memory-core-host-secret | Assistants de secrets de l’hôte de mémoire | | plugin-sdk/memory-core-host-events | Alias de compatibilité déprécié ; utilisez plugin-sdk/memory-host-events | |
plugin-sdk/memory-core-host-status | Assistants d’état de l’hôte de mémoire | | plugin-sdk/memory-core-host-runtime-cli | Assistants d’exécution CLI de l’hôte de mémoire | | plugin-sdk/memory-core-host-runtime-core | Assistants d’exécution de base de l’hôte de mémoire | | plugin-sdk/memory-core-host-runtime-files | Assistants de fichier/exécution de l’hôte de mémoire | |
plugin-sdk/memory-host-core | Alias neutre vis-à-vis du fournisseur pour les assistants d’exécution de base de l’hôte de mémoire | | plugin-sdk/memory-host-events | Alias neutre vis-à-vis du fournisseur pour les assistants du journal des événements de l’hôte de mémoire | | plugin-sdk/memory-host-files | Alias de compatibilité déprécié ; utilisez plugin-sdk/memory-core-host-runtime-files
| | plugin-sdk/memory-host-markdown | Assistants de markdown géré partagés pour les plugins adjacents à la mémoire | | plugin-sdk/memory-host-search | Façade d’exécution de mémoire active pour l’accès au gestionnaire de recherche | | plugin-sdk/memory-host-status | Alias de compatibilité déprécié ; utilisez plugin-sdk/memory-core-host-status |
Sous-chemins d'assistants groupés réservés
Les sous-chemins du SDK d’assistants groupés réservés sont des surfaces spécifiques à leur propriétaire pour le code de plugin groupé. Ils sont suivis dans l’inventaire du SDK afin que les builds de packages et les alias restent déterministes, mais ce ne sont pas des API générales de création de plugins. Les nouveaux contrats d’hôte réutilisables devraient utiliser des sous-chemins génériques du SDK tels que plugin-sdk/gateway-runtime, plugin-sdk/security-runtime et plugin-sdk/plugin-config-runtime.
| Sous-chemin | Propriétaire et objectif |
|---|---|
plugin-sdk/codex-mcp-projection | Assistant de plugin Codex groupé pour projeter la configuration du serveur MCP de l’utilisateur dans la configuration de thread du serveur d’application Codex |
plugin-sdk/codex-native-task-runtime | Assistant de plugin Codex groupé pour mettre en miroir les sous-agents natifs du serveur d’application Codex dans l’état de tâche OpenClaw |