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 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 |
plugin-sdk/health | Inscription, détection, réparation, sélection, gravité et types de résultats des bilans de santé Doctor pour les consommateurs de santé groupés |
Aides à la compatibilité et aux tests obsolètes
Section intitulée « Aides à la compatibilité et aux tests obsolètes »Les sous-chemins dépréciés restent exportés pour les plugins plus anciens, mais le nouveau code devrait utiliser les sous-chemins SDK ciblés ci-dessous. La liste maintenue est scripts/lib/plugin-sdk-deprecated-public-subpaths.json ; l’CI rejette les importations groupées de production provenant de celle-ci. Les “barrels” larges tels que compat, config-types, infra-runtime, text-runtime et zod sont destinés uniquement à la compatibilité. Importez zod directement depuis zod.
Les sous-chemins d’aide aux tests basés sur Vitest d’OpenClaw sont locaux au dépôt uniquement et ne sont plus des exportations de package : agent-runtime-test-contracts, channel-contract-testing, channel-target-testing, channel-test-helpers, plugin-test-api, plugin-test-contracts, plugin-test-runtime, provider-http-test-mocks, provider-test-contracts, test-env, test-fixtures, test-node-mocks et testing.
Sous-chemins d’aide réservés pour les plugins groupés
Section intitulée « Sous-chemins d’aide réservés pour les plugins groupés »Ces sous-chemins sont des surfaces de compatibilité appartenant aux plugins 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 importations d’extension inter-propriétaires sont bloquées par des garde-fous de contrat de package.
Channel subpaths
| Subpath | Key exports |
|---|---|
plugin-sdk/channel-core | defineChannelPluginEntry, defineSetupPluginEntry, createChatChannelPlugin, createChannelPluginBase |
plugin-sdk/config-schema | Root openclaw.json Zod schema export (OpenClawSchema) |
plugin-sdk/json-schema-runtime | Cached JSON Schema validation helper for plugin-owned schemas |
plugin-sdk/channel-setup | createOptionalChannelSetupSurface, createOptionalChannelSetupAdapter, createOptionalChannelSetupWizard, plus DEFAULT_ACCOUNT_ID, createTopLevelChannelDmPolicy, setSetupChannelEnabled, splitSetupEntries |
plugin-sdk/setup | Shared setup wizard helpers, setup translator, allowlist prompts, setup status builders |
plugin-sdk/setup-runtime | createSetupTranslator, createPatchedAccountSetupAdapter, createEnvPatchedAccountSetupAdapter, createSetupInputPresenceValidator, noteChannelLookupFailure, noteChannelLookupSummary, promptResolvedAllowFrom, splitSetupEntries, createAllowlistSetupWizardProxy, createDelegatedSetupWizardProxy |
plugin-sdk/setup-adapter-runtime | Deprecated compatibility alias; use plugin-sdk/setup-runtime |
plugin-sdk/setup-tools | formatCliCommand, detectBinary, extractArchive, resolveBrewExecutable, formatDocsLink, CONFIG_DIR |
plugin-sdk/account-core | Multi-account config/action-gate helpers, default-account fallback helpers |
plugin-sdk/account-id | DEFAULT_ACCOUNT_ID, account-id normalization helpers |
plugin-sdk/account-resolution | Account lookup + default-fallback helpers |
plugin-sdk/account-helpers | Narrow account-list/account-action helpers |
plugin-sdk/access-groups | Access-group allowlist parsing and redacted group diagnostics helpers |
plugin-sdk/channel-pairing | createChannelPairingController |
plugin-sdk/channel-reply-pipeline | Deprecated compatibility facade. Use plugin-sdk/channel-outbound. |
plugin-sdk/channel-config-helpers | createHybridChannelConfigAdapter, resolveChannelDmAccess, resolveChannelDmAllowFrom, resolveChannelDmPolicy, normalizeChannelDmPolicy, normalizeLegacyDmAliases |
plugin-sdk/channel-config-schema | Shared channel config schema primitives plus Zod and direct JSON/TypeBox builders |
plugin-sdk/bundled-channel-config-schema | Bundled OpenClaw channel config schemas for maintained bundled plugins only |
plugin-sdk/chat-channel-ids | BUNDLED_CHAT_CHANNEL_IDS, BUNDLED_CHAT_CHANNEL_ENVELOPE_PREFIXES, ChatChannelId. Canonical bundled/official chat channel ids plus formatter labels/aliases for plugins that need to recognize envelope-prefixed text without hardcoding their own table. |
plugin-sdk/channel-config-schema-legacy | Deprecated compatibility alias for bundled-channel config schemas |
plugin-sdk/telegram-command-config | Telegram custom-command normalization/validation helpers with bundled-contract fallback |
plugin-sdk/command-gating | Narrow command authorization gate helpers |
plugin-sdk/channel-policy | resolveChannelGroupRequireMention |
plugin-sdk/channel-ingress | Deprecated low-level channel ingress compatibility facade. New receive paths should use plugin-sdk/channel-ingress-runtime. |
plugin-sdk/channel-ingress-runtime | Experimental high-level channel ingress runtime resolver and route fact builders for migrated channel receive paths. Prefer this over assembling effective allowlists, command allowlists, and legacy projections in each plugin. See Channel ingress API. |
plugin-sdk/channel-lifecycle | Deprecated compatibility facade. Use plugin-sdk/channel-outbound. |
plugin-sdk/channel-outbound | Message lifecycle contracts plus reply pipeline options, receipts, live preview/streaming, lifecycle helpers, outbound identity, payload planning, durable sends, and message-send context helpers. See Channel outbound API. |
plugin-sdk/channel-message | Deprecated compatibility alias for plugin-sdk/channel-outbound plus legacy reply-dispatch facades. |
plugin-sdk/channel-message-runtime | Deprecated compatibility alias for plugin-sdk/channel-outbound plus legacy reply-dispatch facades. |
plugin-sdk/inbound-envelope | Shared inbound route + envelope builder helpers |
plugin-sdk/inbound-reply-dispatch | Deprecated compatibility facade. Use plugin-sdk/channel-inbound for inbound runners and dispatch predicates, and plugin-sdk/channel-outbound for message delivery helpers. |
plugin-sdk/messaging-targets | Deprecated target parsing alias; use plugin-sdk/channel-targets |
plugin-sdk/outbound-media | Shared outbound media loading helpers |
plugin-sdk/outbound-send-deps | Deprecated compatibility facade. Use plugin-sdk/channel-outbound. |
plugin-sdk/outbound-runtime | Deprecated compatibility facade. Use plugin-sdk/channel-outbound. |
plugin-sdk/poll-runtime | Narrow poll normalization helpers |
plugin-sdk/thread-bindings-runtime | Thread-binding lifecycle and adapter helpers |
plugin-sdk/agent-media-payload | Legacy agent media payload builder |
plugin-sdk/conversation-runtime | Conversation/thread binding, pairing, and configured-binding helpers |
plugin-sdk/runtime-config-snapshot | Runtime config snapshot helper |
plugin-sdk/runtime-group-policy | Runtime group-policy resolution helpers |
plugin-sdk/channel-status | Shared channel status snapshot/summary helpers |
plugin-sdk/channel-config-primitives | Narrow channel config-schema primitives |
plugin-sdk/channel-config-writes | Channel config-write authorization helpers |
plugin-sdk/channel-plugin-common | Shared channel plugin prelude exports |
plugin-sdk/allowlist-config-edit | Allowlist config edit/read helpers |
plugin-sdk/group-access | Shared group-access decision helpers |
plugin-sdk/direct-dm, plugin-sdk/direct-dm-access | Deprecated compatibility facades. Use plugin-sdk/channel-inbound. |
plugin-sdk/direct-dm-guard-policy | Narrow direct-DM pre-crypto guard policy helpers |
plugin-sdk/discord | Deprecated Discord compatibility facade for published @openclaw/[email protected] and tracked owner compatibility; new plugins should use generic channel SDK subpaths |
plugin-sdk/telegram-account | Deprecated Telegram account-resolution compatibility facade for tracked owner compatibility; new plugins should use injected runtime helpers or generic channel SDK subpaths |
plugin-sdk/zalouser | Deprecated Zalo Personal compatibility facade for published Lark/Zalo packages that still import sender command authorization; new plugins should use plugin-sdk/command-auth |
plugin-sdk/interactive-runtime | Semantic message presentation, delivery, and legacy interactive reply helpers. See Message Presentation |
plugin-sdk/channel-inbound | Shared inbound helpers for event classification, context building, formatting, roots, debounce, mention matching, mention-policy, and inbound logging |
plugin-sdk/channel-inbound-debounce | Narrow inbound debounce helpers |
plugin-sdk/channel-mention-gating | Narrow mention-policy, mention marker, and mention text helpers without the broader inbound runtime surface |
plugin-sdk/channel-envelope, plugin-sdk/channel-inbound-roots, plugin-sdk/channel-location, plugin-sdk/channel-logging | Deprecated compatibility facades. Use plugin-sdk/channel-inbound or plugin-sdk/channel-outbound. |
plugin-sdk/channel-pairing-paths | Deprecated compatibility facade. Use plugin-sdk/channel-pairing. |
plugin-sdk/channel-reply-options-runtime | Deprecated compatibility facade. Use plugin-sdk/channel-outbound. |
plugin-sdk/channel-streaming | Deprecated compatibility facade. Use plugin-sdk/channel-outbound. |
plugin-sdk/channel-send-result | Reply result types |
plugin-sdk/channel-actions | Channel message-action helpers, plus deprecated native schema helpers kept for plugin compatibility |
plugin-sdk/channel-route | Shared route normalization, parser-driven target resolution, thread-id stringification, dedupe/compact route keys, parsed-target types, and route/target comparison helpers |
plugin-sdk/channel-targets | Target parsing helpers; route comparison callers should use plugin-sdk/channel-route |
plugin-sdk/channel-contract | Channel contract types |
plugin-sdk/channel-feedback | Feedback/reaction wiring |
plugin-sdk/channel-secret-runtime | Narrow secret-contract helpers such as collectSimpleChannelFieldAssignments, getChannelSurface, pushAssignment, and secret target types |
Les familles d’assistants de canal dépréciées restent disponibles uniquement pour la compatibilité des plugins publiés. Le plan de suppression est le suivant : les conserver pendant la fenêtre de migration des plugins externes, maintenir les plugins de dépôt/bundlé 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/exécution de canal, de streaming de canal, d’accès DM direct, de scission d’assistant entrant, d’options de réponse et de chemin d’appariement.
Provider subpaths
| Subpath | Key exports | | --- | --- | | plugin-sdk/provider-entry | defineSingleProviderPluginEntry | | plugin-sdk/lmstudio | Facade 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 | Facade d’exécution LM Studio prise en charge pour les serveurs locaux par défaut, 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 fournisseurs locaux/auto-hébergés sélectionnés | | plugin-sdk/self-hosted-provider-setup | Assistants de configuration de fournisseurs auto-hébergés compatibles OpenAI ciblés | | plugin-sdk/cli-backend | Valeurs par défaut du backend CLI +
constantes de surveillance | | plugin-sdk/provider-auth-runtime | Assistants de résolution de clé d’API à l’exécution pour les plugins de fournisseurs | | plugin-sdk/provider-oauth-runtime | Types de rappel OAuth de fournisseur générique, rendu de page de rappel, assistants PKCE/état, analyse des entrées d’autorisation, assistants d’expiration de jeton et assistants d’abandon | |
plugin-sdk/provider-auth-api-key | Assistants de configuration d’onboarding/écriture de profil de clé d’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, assistants d’importation d’authentification Codex OpenAI, export de compatibilité obsolète resolveOpenClawAgentDir | | 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 fournisseurs et interfaces de registre de plugin-fournisseur pour les tests de contrat | | 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érique, 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 ciblés tels que enablePluginInConfig et WebFetchProviderPlugin | | plugin-sdk/provider-web-fetch | Assistants d’enregistrement/de cache de fournisseur de récupération Web | | plugin-sdk/provider-web-search-config-contract | Assistants de configuration/d’identifiants de
recherche Web ciblés pour les fournisseurs qui n’ont pas besoin de câblage d’activation de plugin | | plugin-sdk/provider-web-search-contract | Assistants de contrat de configuration/d’identifiants de recherche Web ciblés tels que createWebSearchProviderContractFields, enablePluginInConfig, resolveProviderWebSearchPluginConfig, et définitions/récupérateurs d’identifiants délimités | |
plugin-sdk/provider-web-search | Assistants d’enregistrement/cache/exécution de fournisseur de recherche Web | | plugin-sdk/embedding-providers | Types et assistants de lecture de fournisseurs d’intégration généraux, y compris EmbeddingProviderAdapter, getEmbeddingProvider(...) et listEmbeddingProviders(...) ; les plugins enregistrent les fournisseurs via
api.registerEmbeddingProvider(...) afin que la propriété du manifeste soit appliquée | | plugin-sdk/provider-tools | ProviderToolCompatFamily, buildProviderToolCompatFamilyHooks et nettoyage + diagnostics de schéma DeepSeek/Gemini/OpenAI | | plugin-sdk/provider-usage | Types de instantanés d’utilisation du fournisseur, assistants de récupération d’utilisation partagée et récupérateurs
de fournisseurs tels que fetchClaudeUsage | | plugin-sdk/provider-stream | ProviderStreamFamily, buildProviderStreamFamilyHooks, composeProviderStreamWrappers, types de wrappers de flux, compatibilité d’appel d’outil en texte brut et assistants de wrapper partagés Anthropic/Bedrock/DeepSeek V4/Google/Kilocode/Moonshot/OpenAI/OpenRouter/Z.A.I/MiniMax/Copilot | |
plugin-sdk/provider-stream-shared | Assistants de wrapper de flux de fournisseur partagé publics, y compris composeProviderStreamWrappers, createPlainTextToolCallCompatWrapper, createPayloadPatchStreamWrapper, createToolStreamWrapper et utilitaires de flux compatibles Anthropic/DeepSeek/OpenAI | | plugin-sdk/provider-transport-runtime | Assistants de transport de fournisseur natifs
tels que la récupération sécurisée, les transformations de messages de transport et les flux d’événements de transport inscriptibles | | plugin-sdk/provider-onboard | Assistants de correctifs de configuration d’intégration | | plugin-sdk/global-singleton | Assistants de singleton/carte/cache local au processus | | plugin-sdk/group-activation | Assistants d’analyse de commande et de mode
d’activation de groupe ciblés |
Les instantanés d’utilisation du fournisseur signalent généralement un ou plusieurs windows de quota, chacun avec un libellé, un pourcentage utilisé et une heure de réinitialisation facultative. Les fournisseurs qui exposent du texte sur le solde ou l’état du compte au lieu de fenêtres de quota réinitialisables doivent renvoyer summary avec un tableau windows vide plutôt que de fabriquer 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 utilisable.
Sous-chemins d'authentification et de sécurité
| Sous-chemin | Exportations clés | | --- | --- | | plugin-sdk/command-auth | resolveControlCommandGate, helpers de registre de commandes incluant le formatage dynamique des menus d’arguments, helpers d’autorisation de l’expéditeur | | plugin-sdk/command-status | Constructeurs de messages de commande/aide tels que buildCommandsMessagePaginated et buildHelpMessage | |
plugin-sdk/approval-auth-runtime | Helpers de résolution de l’approbateur et d’authentification des actions de même chat | | plugin-sdk/approval-client-runtime | Helpers de 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 | Helper partagé de résolution
de passerelle d’approbation | | plugin-sdk/approval-handler-adapter-runtime | Helpers de chargement d’adaptateurs d’approbation native légers pour les points d’entrée de canal à chaud | | plugin-sdk/approval-handler-runtime | Helpers d’exécution plus larges pour le gestionnaire d’approbation ; privilégiez les interfaces plus étroites d’adaptateur/passerelle lorsqu’elles suffisent | |
plugin-sdk/approval-native-runtime | Helpers de cible d’approbation native, de liaison de compte, de porte de routage, de repli de transfert, et de suppression d’invite d’exécution native locale | | plugin-sdk/approval-reaction-runtime | Liaisons de réaction d’approbation codées en dur, charges utiles d’invite de réaction, magasins de cibles de réaction, et exportation de compatibilité pour
la suppression d’invite d’exécution native locale | | plugin-sdk/approval-reply-runtime | Helpers de charge utile de réponse d’approbation d’exécution/plugin | | plugin-sdk/approval-runtime | Helpers de charge utile d’approbation d’exécution/plugin, helpers de routage/exécution d’approbation native, et helpers d’affichage d’approbation structurée tels que formatApprovalDisplayPath | |
plugin-sdk/reply-dedupe | Helpers étroits de réinitialisation de déduplication de réponse entrante | | plugin-sdk/channel-contract-testing | Helpers de test de contrat de canal étroits sans le module de test large | | plugin-sdk/command-auth-native | Authentification de commande native, formatage dynamique des menus d’arguments, et helpers de cible de session native | |
plugin-sdk/command-detection | Helpers partagés de détection de commande | | plugin-sdk/command-primitives-runtime | Prédicats de texte de commande légers pour les chemins de canal à chaud | | plugin-sdk/command-surface | Normalisation du corps de commande et helpers de surface de commande | | plugin-sdk/allow-from | formatAllowFromLowercase | | plugin-sdk/channel-secret-runtime |
Helpers de collection de contrats de secret étroits pour les surfaces de secret de canal/plugin | | plugin-sdk/secret-ref-runtime | Helpers coerceSecretRef étroits et de typage SecretRef pour l’analyse de contrat de secret/config | | plugin-sdk/secret-provider-integration | Manifeste d’intégration de provider SecretRef (types uniquement) et contrats prédéfinis pour les plugins qui publient
des préréglages de provider de secret externe | | plugin-sdk/security-runtime | Helpers de confiance partagée, de gate DM, de fichier/chemin borné racine incluant les écritures en création uniquement, le remplacement de fichier atomique synchrone/asynchrone, les écritures temporaires frères, le repli de déplacement inter-appareils, les helpers de stockage de fichiers privés, les gardiens de
parent de lien symbolique, le contenu externe, la suppression de texte sensible, la comparaison de secret à temps constant, et les helpers de collection de secret | | plugin-sdk/ssrf-policy | Helpers de stratégie SSRF de liste d’autorisation d’hôte et de réseau privé | | plugin-sdk/ssrf-dispatcher | Helpers étroits de répartiteur épinglé sans la surface d’exécution d’infrastructure large | |
plugin-sdk/ssrf-runtime | Répartiteur épinglé, récupération protégée SSRF, erreur SSRF, et helpers de stratégie SSRF | | plugin-sdk/secret-input | Helpers d’analyse d’entrée de secret | | plugin-sdk/webhook-ingress | Helpers de requête/cible de webhook et contrainte websocket/corps brute | | plugin-sdk/webhook-request-guards | Helpers de taille/délai d’attente du corps de la requête |
Sous-chemins d'exécution et de stockage
| Sous-chemin | Exportations clés | | --- | --- | | plugin-sdk/runtime | Assistants larges pour l’exécution, la journalisation, la sauvegarde et l’installation de plugins | | plugin-sdk/runtime-env | Assistants étroits pour l’environnement d’exécution, la journalisation, le délai d’attente, la réessaye et l’attente exponentielle | | plugin-sdk/browser-config | Façade de configuration de
navigateur prise en charge pour les profils/défauts normalisés, l’analyse d’URL CDP et les assistants d’authentification de contrôle du navigateur | | plugin-sdk/agent-harness-task-runtime | Assistants génériques de cycle de vie des tâches et de livraison d’achèvement pour les agents soutenus par un harnais utilisant une portée de tâche émise par l’hôte | | plugin-sdk/codex-mcp-projection |
Assistant Codex groupé réservé pour projeter la configuration du serveur MCP de l’utilisateur dans la configuration du fil Codex ; non destiné aux plugins tiers | | plugin-sdk/codex-native-task-runtime | Assistant Codex groupé privé pour le câblage natif du miroir/exécution des tâches ; non destiné aux plugins tiers | | plugin-sdk/channel-runtime-context | Assistants génériques
d’enregistrement et de recherche du contexte d’exécution du channel | | plugin-sdk/matrix | Façade de compatibilité Matrix obsolète pour les anciens packages tiers de channel ; les nouveaux plugins doivent importer plugin-sdk/run-command directement | | plugin-sdk/mattermost | Façade de compatibilité Mattermost obsolète pour les anciens packages tiers de channel ; 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 de commande/hook/http/interactif de plugin | | plugin-sdk/hook-runtime | Assistants partagés de pipeline de webhook/hook interne | | plugin-sdk/lazy-runtime | Assistants d’importation/liaison d’exécution différés
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 différés | | plugin-sdk/qa-live-transport-scenarios | Identifiants de scénario QA de transport en
direct partagés, assistants de couverture de base et assistant de sélection de scénario | | plugin-sdk/gateway-method-runtime | Assistant de répartition de méthode Gateway réservé pour les itinéraires HTTP de plugin qui déclarent contracts.gatewayMethodDispatch: ["authenticated-request"] | | plugin-sdk/gateway-runtime | Client GatewayCLIRPC, assistant de démarrage de client prêt pour la
boucle d’événements, RPC CLI de passerelle, erreurs de protocole de passerelle et assistants de correctif d’état de channel | | plugin-sdk/config-contracts | Surface de configuration de type uniquement ciblée pour les formes de configuration de plugin telles que OpenClawConfig et les types de configuration de channel/fournisseur | | 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 de configuration transactionnelle tels que mutateConfigFile, replaceConfigFile et logConfigUpdated | | plugin-sdk/runtime-config-snapshot | Assistants de instantané de configuration de
processus actuel tels que getRuntimeConfig, getRuntimeConfigSnapshot et les définitions d’instantané de test | | plugin-sdk/telegram-command-config | Normalisation du nom/description de commande et vérifications des doublons/conflits Telegram, même lorsque la surface de contrat Telegram groupée n’est pas disponible | | plugin-sdk/text-autolink-runtime | Détection d’autolien de référence
de fichier sans le module de texte large | | plugin-sdk/approval-reaction-runtime | Liaisons de réaction d’approbation codées en dur, charges utiles d’invite de réaction, magasins de cibles de réaction et exportation de compatibilité pour la suppression des invites d’exécution natives locales | | 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/exécution natifs et formatage du chemin d’affichage d’approbation structurée | | plugin-sdk/reply-runtime | Assistants d’exécution entrante/réponse partagés, segmentation, répartition, pulsation, 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 carte de niveau inférieur restent des exportations de compatibilité obsolètes uniquement | | plugin-sdk/reply-reference | createReplyReferencePlanner | |
plugin-sdk/reply-chunking | Assistants étroits de segmentation de texte/markdown | | plugin-sdk/session-store-runtime | Assistants de workflow de session (getSessionEntry, listSessionEntries, patchSessionEntry, upsertSessionEntry), assistants hérités de chemin de magasin de session/clé de session, lectures de mise à jour et assistants de mutation de magasin entier obsolètes | |
plugin-sdk/cron-store-runtime | Assistants de chemin/chargement/sauvegarde de magasin Cron | | plugin-sdk/state-paths | Assistants de chemin de répertoire State/OAuth | | plugin-sdk/plugin-state-runtime | Types d’état indexés SQLite sidecar de plugin | | plugin-sdk/routing | Assistants de liaison de 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 | Lanceur de commande minuté avec résultats stdout/stderr normalisés | | plugin-sdk/param-readers | Lecteurs de paramètres d’outil/CLI courants | | plugin-sdk/tool-plugin | Définir un plugin d’outil d’agent 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’envi canoniques des arguments d’outil | | plugin-sdk/sandbox | Types de backend Sandbox et assistants de commande SSH/OpenShell, y compris la vérification préalable rapide de la commande d’exécution | |
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 | Assistants de journalisation de sous-système et 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 fournisseur Talk | | plugin-sdk/json-store | Petits assistants de lecture/écriture d’état JSON | | plugin-sdk/json-unsafe-integers | Assistants d’analyse JSON qui préservent les littéraux d’entiers non sécurisés sous
forme de chaînes | | plugin-sdk/file-lock | Assistants de verrouillage de fichier réentrant | | plugin-sdk/persistent-dedupe | Assistants de cache de déduplication 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’enregistrement 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 de schéma de configuration d’exécution d’agent étroit | | plugin-sdk/boolean-param | Lecteur de paramètre booléen lâche | | 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’appariement | | plugin-sdk/extension-shared | Primitives d’assistant partagé de channel passif, d’état et de proxy ambiant | | plugin-sdk/models-provider-runtime | Assistants de réponse de commande/fournisseur /models | | plugin-sdk/skill-commands-runtime
| Assistants de liste de commandes Skill | | plugin-sdk/native-command-registry | Assistants de registre/construction/sérialisation de commande native | | plugin-sdk/agent-harness | Surface de plugin de confiance expérimentale pour les 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ésultat de tentative | | plugin-sdk/provider-zai-endpoint | Façade de détection de point de terminaison propriétaire du fournisseur Z.AI obsolète ; utilisez l’API publique du plugin Z.AI | | API | 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âche asynchrone bornée | | plugin-sdk/dedupe-runtime | Assistants de cache de déduplication en mémoire | | plugin-sdk/delivery-queue-runtime | Assistant de
vidage de livraison en attente sortante | | plugin-sdk/file-access-runtime | Assistants de chemin de fichier local et de source média sécurisés | | plugin-sdk/heartbeat-runtime | Assistants de réveil, d’événement et de visibilité de pulsation | | plugin-sdk/number-runtime | Assistant de contrainte 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/exec-approvals-runtime | Assistants de fichier de stratégie d’approbation d’exécution sans le module d’infrastructure d’exécution large | | 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 partagés de classification d’erreurs, 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/inline-image-data-url-runtime | Assainisseur d’URL de données d’image en ligne et assistants de détection de signature sans la surface d’exécution média
large | | plugin-sdk/response-limit-runtime | Lecteur de corps de réponse borné sans la surface d’exécution média large | | plugin-sdk/session-binding-runtime | État de liaison de conversation actuel sans routage de liaison configuré ou magasins d’appariement | | 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é de contexte et filtrage de contexte supplémentaire sans importations de configuration/sécurité large | | plugin-sdk/string-coerce-runtime | Assistants étroits de contrainte et de normalisation d’enregistrement/chaîne primitive sans importations markdown/logging | | plugin-sdk/host-runtime | Assistants de
normalisation d’hôte et d’hôte SCP | | plugin-sdk/retry-runtime | Assistants de configuration de réessaye et de lanceur de réessaye | | 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 soutenu 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 fetchRemoteMedia ; 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 (failover) pour la génération de médias, la sélection des candidats
et la messagerie de modèle manquant | | plugin-sdk/media-understanding | Types de fournisseurs de compréhension des médias plus les exportations d’assistants d’extraction d’image/audio/structure 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/speech | Types de fournisseurs de synthèse vocale plus les exportations d’assistants de directive, de registre, de validation, de constructeur TTS compatible OpenAI et d’assistants vocaux | | plugin-sdk/speech-core | Types partagés de fournisseurs de synthèse vocale, registre, directive,
normalisation et exportations d’assistants vocaux | | plugin-sdk/realtime-transcription | Types de fournisseurs de transcription en temps réel, assistants de registre et assistant de session WebSocket partagé | | plugin-sdk/realtime-bootstrap-context | Assistant d’amorçage de profil en temps réel pour l’injection de contexte bornée IDENTITY.md, USER.md et SOUL.md | |
plugin-sdk/realtime-voice | Types de fournisseurs vocaux en temps réel, assistants de registre et assistants partagés de comportement vocal en temps réel, y compris le suivi de l’activité de sortie | | plugin-sdk/image-generation | Types de fournisseurs de génération d’images plus les assistants d’actif/URL de 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 de musique | | plugin-sdk/music-generation-core | Types partagés de génération de musique, 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 de vidéo | | plugin-sdk/video-generation-core | Types partagés de génération de vidéo, assistants de basculement, recherche de fournisseur et analyse de référence de modèle | | plugin-sdk/transcripts | Types partagés de fournisseurs de sources de transcription, assistants de registre, descripteurs
de session et métadonnées d’énoncé | | 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/testing | Baril (barrel) de compatibilité obsolète local au dépôt pour les tests OpenClaw hérités. Les nouveaux tests du dépôt devraient 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 à la place | | plugin-sdk/plugin-test-api | Assistant minimal local au dépôt createTestPluginApi pour les tests unitaires d’enregistrement direct de plugins sans importer les ponts d’assistants de test du 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 hook 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 local 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 hooks | | plugin-sdk/channel-target-testing | Suite de cas d’erreur de résolution de cible partagée local au dépôt pour les tests de canal | | plugin-sdk/plugin-test-contracts | 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 local 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 politique de relecture, de STT temps réel audio en direct, de recherche/récupération web et de flux local au dépôt | | plugin-sdk/provider-http-test-mocks | Simulations HTTP/auth
Vitest optionnelles local au dépôt pour les tests de fournisseurs qui exercent plugin-sdk/provider-http | | plugin-sdk/test-fixtures | Fixtures de capture d’exécution générique CLI, de contexte de bac à sable, d’enregistreur de compétences, 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é local au dépôt | | plugin-sdk/test-node-mocks | Assistants ciblés de simulation intégrée Node local au dépôt à utiliser dans les fabriques vi.mock("node:*") Vitest |
Sous-chemins de mémoire
| Sous-chemin | Exportations clés | | --- | --- | | plugin-sdk/memory-core | Surface d’aide memory-core regroupée pour les aides de gestionnaire/configuration/fichier/CLI | | plugin-sdk/memory-core-engine-runtime | Façade d’exécution d’index/recherche mémoire | | plugin-sdk/memory-core-host-embedding-registry | Aides légères de registre de provider d’incorporation mémoire | |
plugin-sdk/memory-core-host-engine-foundation | Exportations du moteur de base de l’hôte mémoire | | plugin-sdk/memory-core-host-engine-embeddings | Contrats d’incorporation, accès au registre, provider local et aides génériques de traitement par lot/distant de l’hôte mémoire. registerMemoryEmbeddingProvider sur cette surface est obsolète ; utilisez l’API de provider d’incorporation
générique pour les nouveaux providers. | | plugin-sdk/memory-core-host-engine-qmd | Exportations du moteur QMD de l’hôte mémoire | | plugin-sdk/memory-core-host-engine-storage | Exportations du moteur de stockage de l’hôte mémoire | | plugin-sdk/memory-core-host-multimodal | Aides multimodales de l’hôte mémoire | | plugin-sdk/memory-core-host-query | Aides de requête de l’hôte mémoire |
| plugin-sdk/memory-core-host-secret | Aides de secret de l’hôte mémoire | | plugin-sdk/memory-core-host-events | Alias de compatibilité obsolète ; utilisez plugin-sdk/memory-host-events | | plugin-sdk/memory-core-host-status | Aides de statut de l’hôte mémoire | | plugin-sdk/memory-core-host-runtime-cli | Aides d’exécution CLI de l’hôte mémoire | |
plugin-sdk/memory-core-host-runtime-core | Aides d’exécution de base de l’hôte mémoire | | plugin-sdk/memory-core-host-runtime-files | Aides de fichier/exécution de l’hôte mémoire | | plugin-sdk/memory-host-core | Alias neutre par rapport au fournisseur pour les aides d’exécution de base de l’hôte mémoire | | plugin-sdk/memory-host-events | Alias neutre par rapport au fournisseur pour
les aides du journal d’événements de l’hôte mémoire | | plugin-sdk/memory-host-files | Alias de compatibilité obsolète ; utilisez plugin-sdk/memory-core-host-runtime-files | | plugin-sdk/memory-host-markdown | Aides de Markdown gérées partagées 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é obsolète ; utilisez plugin-sdk/memory-core-host-status |
Reserved bundled-helper subpaths
Les sous-chemins d’assistant SDK regroupés réservés sont des interfaces spécifiques au propriétaire pour le code de plugin regroupé. 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 de création de plugins générales. Les nouveaux contrats d’hôte réutilisables doivent utiliser des sous-chemins SDK génériques tels que plugin-sdk/gateway-runtime, plugin-sdk/security-runtime et plugin-sdk/plugin-config-runtime.
| Subpath | Owner and purpose |
|---|---|
plugin-sdk/codex-mcp-projection | Assistant du plugin Codex regroupé pour projeter la configuration du serveur MCP de l’utilisateur dans la configuration du thread du serveur d’application Codex |
plugin-sdk/codex-native-task-runtime | Assistant du plugin Codex regroupé pour refléter les sous-agents natifs du serveur d’application Codex dans l’état de tâche OpenClaw |