​

Plugin-SDK-Überblick

​

Importkonvention

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

​

Referenz der Subpaths

​

Plugin-Einstiegspunkt

​

Registrierungs-API

​

Registrierung von Fähigkeiten

​

Tools und Befehle

​

Infrastruktur

​

CLI-Registrierungsmetadaten

• commands: explizite Befehls-Roots, die dem Registrar gehören
• descriptors: Parse-Time-Befehlsdeskriptoren, die für Root-CLI-Hilfe, Routing und lazy Plugin-CLI-Registrierung verwendet werden

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,
      },
    ],
  },
);

​

Registrierung von CLI-Backends

• Die Backend-id wird zum Provider-Präfix in Modellreferenzen wie codex-cli/gpt-5.
• Die Backend-config verwendet dieselbe Form wie agents.defaults.cliBackends.<id>.
• Benutzerkonfiguration gewinnt weiterhin. OpenClaw führt agents.defaults.cliBackends.<id> über die Plugin-Standardeinstellung zusammen, bevor die CLI ausgeführt wird.
• Verwenden Sie normalizeConfig, wenn ein Backend nach dem Zusammenführen Kompatibilitäts-Umschreibungen braucht (zum Beispiel zur Normalisierung alter Flag-Formen).

​

Exklusive Slots

​

Adapter für Memory-Embeddings

• registerMemoryCapability ist die bevorzugte API für exklusive Memory-Plugins.
• registerMemoryCapability kann auch publicArtifacts.listArtifacts(...) bereitstellen, sodass Begleit-Plugins exportierte Memory-Artefakte über openclaw/plugin-sdk/memory-host-core konsumieren können, statt in das private Layout eines bestimmten Memory-Plugins zu greifen.
• registerMemoryPromptSection, registerMemoryFlushPlan und registerMemoryRuntime sind Legacy-kompatible APIs für exklusive Memory-Plugins.
• registerMemoryEmbeddingProvider erlaubt es dem aktiven Memory-Plugin, einen oder mehrere Embedding-Adapter-IDs zu registrieren (zum Beispiel openai, gemini oder eine benutzerdefinierte ID des Plugins).
• Benutzerkonfiguration wie agents.defaults.memorySearch.provider und agents.defaults.memorySearch.fallback wird gegen diese registrierten Adapter-IDs aufgelöst.

​

Ereignisse und Lebenszyklus

​

Entscheidungssemantik von Hooks

• before_tool_call: Die Rückgabe von { block: true } ist terminal. Sobald ein Handler dies setzt, werden Handler mit niedrigerer Priorität übersprungen.
• before_tool_call: Die Rückgabe von { block: false } wird als keine Entscheidung behandelt (wie das Weglassen von block), nicht als Override.
• before_install: Die Rückgabe von { block: true } ist terminal. Sobald ein Handler dies setzt, werden Handler mit niedrigerer Priorität übersprungen.
• before_install: Die Rückgabe von { block: false } wird als keine Entscheidung behandelt (wie das Weglassen von block), nicht als Override.
• reply_dispatch: Die Rückgabe von { handled: true, ... } ist terminal. Sobald ein Handler den Dispatch beansprucht, werden Handler mit niedrigerer Priorität und der standardmäßige Modell-Dispatch-Pfad übersprungen.
• message_sending: Die Rückgabe von { cancel: true } ist terminal. Sobald ein Handler dies setzt, werden Handler mit niedrigerer Priorität übersprungen.
• message_sending: Die Rückgabe von { cancel: false } wird als keine Entscheidung behandelt (wie das Weglassen von cancel), nicht als Override.

​

Felder des API-Objekts

​

Interne Modulkonvention

my-plugin/
  api.ts            # Öffentliche Exporte für externe Verbraucher
  runtime-api.ts    # Nur interne Laufzeit-Exporte
  index.ts          # Plugin-Einstiegspunkt
  setup-entry.ts    # Leichtgewichtiger nur-Setup-Einstiegspunkt (optional)

• @openclaw/openai-provider: api.ts exportiert Provider-Builder, Standardmodell-Helfer und Builder für Realtime-Provider
• @openclaw/openrouter-provider: api.ts exportiert den Provider-Builder sowie Helfer für Onboarding/Konfiguration

​

Verwandt

• Entry Points — Optionen für definePluginEntry und defineChannelPluginEntry
• Runtime Helpers — vollständige Referenz des Namespace api.runtime
• Setup and Config — Packaging, Manifeste, Konfigurationsschemata
• Testing — Test-Utilities und Lint-Regeln
• SDK Migration — Migration von veralteten Oberflächen
• Plugin Internals — tiefgehende Architektur und Fähigkeitsmodell