​

Vue d’ensemble du SDK des plugins

​

Convention d’import

import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";
import { defineChannelPluginEntry } from "openclaw/plugin-sdk/channel-core";

​

Référence des sous-chemins

​

Entrée de plugin

​

API d’enregistrement

​

Enregistrement des capacités

​

Outils et commandes

​

Infrastructure

​

Métadonnées d’enregistrement CLI

• commands : racines de commande explicites possédées par le registrar
• descriptors : descripteurs de commande au moment de l’analyse utilisés pour l’aide CLI racine, le routage et l’enregistrement CLI paresseux du plugin

api.registerCli(
  async ({ program }) => {
    const { registerMatrixCli } = await import("./src/cli.js");
    registerMatrixCli({ program });
  },
  {
    descriptors: [
      {
        name: "matrix",
        description: "Manage Matrix accounts, verification, devices, and profile state",
        hasSubcommands: true,
      },
    ],
  },
);

​

Enregistrement du backend CLI

• L’id du backend devient le préfixe fournisseur dans des références de modèle comme claude-cli/opus.
• La config du backend utilise la même forme que agents.defaults.cliBackends.<id>.
• La configuration utilisateur reste prioritaire. OpenClaw fusionne agents.defaults.cliBackends.<id> sur la valeur par défaut du plugin avant d’exécuter la CLI.
• Utilisez normalizeConfig lorsqu’un backend a besoin de réécritures de compatibilité après fusion (par exemple normaliser d’anciennes formes de drapeau).

​

Slots exclusifs

​

Adaptateurs d’embeddings mémoire

• registerMemoryPromptSection, registerMemoryFlushPlan et registerMemoryRuntime sont exclusifs aux plugins mémoire.
• registerMemoryEmbeddingProvider permet au plugin mémoire actif d’enregistrer un ou plusieurs IDs d’adaptateur (par exemple openai, gemini, ou un ID défini par un plugin personnalisé).
• La configuration utilisateur telle que agents.defaults.memorySearch.provider et agents.defaults.memorySearch.fallback se résout par rapport à ces IDs d’adaptateur enregistrés.

​

Événements et cycle de vie

​

Sémantique des décisions de hook

• before_tool_call : renvoyer { block: true } est terminal. Dès qu’un gestionnaire le définit, les gestionnaires de priorité inférieure sont ignorés.
• before_tool_call : renvoyer { block: false } est traité comme absence de décision (comme si block était omis), pas comme un remplacement.
• before_install : renvoyer { block: true } est terminal. Dès qu’un gestionnaire le définit, les gestionnaires de priorité inférieure sont ignorés.
• before_install : renvoyer { block: false } est traité comme absence de décision (comme si block était omis), pas comme un remplacement.
• message_sending : renvoyer { cancel: true } est terminal. Dès qu’un gestionnaire le définit, les gestionnaires de priorité inférieure sont ignorés.
• message_sending : renvoyer { cancel: false } est traité comme absence de décision (comme si cancel était omis), pas comme un remplacement.

​

Champs de l’objet API

​

Convention des modules internes

my-plugin/
  api.ts            # Exports publics pour les consommateurs externes
  runtime-api.ts    # Exports runtime internes uniquement
  index.ts          # Point d’entrée du plugin
  setup-entry.ts    # Entrée légère dédiée à la configuration (facultatif)

• @openclaw/openai-provider : api.ts exporte des constructeurs de fournisseur, des assistants de modèle par défaut et des constructeurs de fournisseur temps réel
• @openclaw/openrouter-provider : api.ts exporte le constructeur de fournisseur ainsi que des assistants d’onboarding/configuration

​

Lié

• Points d’entrée — options de definePluginEntry et defineChannelPluginEntry
• Assistants runtime — référence complète de l’espace de noms api.runtime
• Configuration et setup — packaging, manifestes, schémas de configuration
• Tests — utilitaires de test et règles de lint
• Migration SDK — migration depuis des surfaces dépréciées
• Internes des plugins — architecture approfondie et modèle de capacités