​

Punti di ingresso dei plugin

​

definePluginEntry

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

export default definePluginEntry({
  id: "my-plugin",
  name: "My Plugin",
  description: "Short summary",
  register(api) {
    api.registerProvider({
      /* ... */
    });
    api.registerTool({
      /* ... */
    });
  },
});

• id deve corrispondere al tuo manifest openclaw.plugin.json.
• kind è per slot esclusivi: "memory" o "context-engine".
• configSchema può essere una funzione per la valutazione lazy.
• OpenClaw risolve e memoizza quello schema al primo accesso, quindi i builder di schema costosi vengono eseguiti una sola volta.

​

defineChannelPluginEntry

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

export default defineChannelPluginEntry({
  id: "my-channel",
  name: "My Channel",
  description: "Short summary",
  plugin: myChannelPlugin,
  setRuntime: setMyRuntime,
  registerCliMetadata(api) {
    api.registerCli(/* ... */);
  },
  registerFull(api) {
    api.registerGatewayMethod(/* ... */);
  },
});

• setRuntime viene chiamato durante la registrazione così puoi memorizzare il riferimento runtime (tipicamente tramite createPluginRuntimeStore). Viene saltato durante la raccolta dei metadati CLI.
• registerCliMetadata viene eseguito sia quando api.registrationMode === "cli-metadata" sia quando api.registrationMode === "full". Usalo come punto canonico per i descrittori CLI posseduti dal canale, così l’help root resta non attivante mentre la normale registrazione dei comandi CLI rimane compatibile con i caricamenti completi del plugin.
• registerFull viene eseguito solo quando api.registrationMode === "full". Viene saltato durante il caricamento setup-only.
• Come definePluginEntry, configSchema può essere una factory lazy e OpenClaw memoizza lo schema risolto al primo accesso.
• Per i comandi CLI root posseduti dal plugin, preferisci api.registerCli(..., { descriptors: [...] }) quando vuoi che il comando resti caricato lazy senza scomparire dall’albero di parsing della CLI root. Per i plugin di canale, preferisci registrare quei descrittori da registerCliMetadata(...) e mantenere registerFull(...) focalizzato sul lavoro solo runtime.
• Se registerFull(...) registra anche metodi RPC del gateway, mantienili su un prefisso specifico del plugin. Gli spazi dei nomi admin core riservati (config.*, exec.approvals.*, wizard.*, update.*) vengono sempre coercizzati a operator.admin.

​

defineSetupPluginEntry

import { defineSetupPluginEntry } from "openclaw/plugin-sdk/channel-core";

export default defineSetupPluginEntry(myChannelPlugin);

• openclaw/plugin-sdk/setup-runtime per helper di setup sicuri per il runtime come adapter di patch setup import-safe, output di note lookup, promptResolvedAllowFrom, splitSetupEntries e proxy di setup delegati
• openclaw/plugin-sdk/channel-setup per superfici di setup con installazione facoltativa
• openclaw/plugin-sdk/setup-tools per helper di setup/installazione CLI/archivio/documentazione

​

Modalità di registrazione

register(api) {
  if (api.registrationMode === "cli-metadata" || api.registrationMode === "full") {
    api.registerCli(/* ... */);
    if (api.registrationMode === "cli-metadata") return;
  }

  api.registerChannel({ plugin: myPlugin });
  if (api.registrationMode !== "full") return;

  // Registrazioni pesanti solo runtime
  api.registerService(/* ... */);
}

• usa descriptors quando il registrar possiede uno o più comandi root e vuoi che OpenClaw carichi lazy il modulo CLI reale alla prima invocazione
• assicurati che quei descrittori coprano ogni root di comando di primo livello esposta dal registrar
• usa solo commands per i percorsi di compatibilità eager

​

Forme dei plugin

​

Correlati

• Panoramica SDK — API di registrazione e riferimento dei sottopercorsi
• Helper runtime — api.runtime e createPluginRuntimeStore
• Setup e configurazione — manifest, setup entry, caricamento differito
• Plugin di canale — costruzione dell’oggetto ChannelPlugin
• Plugin provider — registrazione provider e hook