Overzicht van de Plugin SDK

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

Importconventie

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

​

Subpadreferentie

​

Registratie-API

​

Capability-registratie

​

Tools en opdrachten

​

Infrastructuur

​

Host-hooks voor workflowplugins

• Externe plugins kunnen eigenaar zijn van sessie-extensies, UI-descriptoren, opdrachten, toolmetadata, next-turn-injecties en normale hooks.
• Vertrouwd toolbeleid draait voor gewone before_tool_call-hooks en is alleen voor meegeleverde plugins, omdat het deelneemt aan het veiligheidsbeleid van de host.
• Gereserveerd opdrachteigendom is alleen voor meegeleverde plugins. Externe plugins moeten hun eigen opdrachtnamen of aliassen gebruiken.
• allowPromptInjection=false schakelt promptwijzigende hooks uit, waaronder agent_turn_prepare, before_prompt_build, heartbeat_prompt_contribution, promptvelden uit legacy before_agent_start en enqueueNextTurnInjection.

​

Gateway-discoveryregistratie

api.registerGatewayDiscoveryService({
  id: "my-discovery",
  async advertise(ctx) {
    const handle = await startMyAdvertiser({
      gatewayPort: ctx.gatewayPort,
      tls: ctx.gatewayTlsEnabled,
      displayName: ctx.machineDisplayName,
    });
    return { stop: () => handle.stop() };
  },
});

​

CLI-registratiemetadata

• commands: expliciete commandoroots die eigendom zijn van de registrar
• descriptors: commandodescriptors voor parsetijd die worden gebruikt voor root-CLI-hulp, routering en luie CLI-registratie van plugins

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

​

CLI-backendregistratie

• De backend-id wordt het providerprefix in modelreferenties zoals codex-cli/gpt-5.
• De backend-config gebruikt dezelfde vorm als agents.defaults.cliBackends.<id>.
• Gebruikersconfiguratie wint nog steeds. OpenClaw voegt agents.defaults.cliBackends.<id> samen boven op de pluginstandaard voordat de CLI wordt uitgevoerd.
• Gebruik normalizeConfig wanneer een backend compatibiliteitsherschrijvingen nodig heeft na het samenvoegen (bijvoorbeeld het normaliseren van oude flag-vormen).

​

Exclusieve slots

​

Adapters voor geheugenembeddings

• registerMemoryCapability is de voorkeurs-API voor exclusieve geheugenplugins.
• registerMemoryCapability kan ook publicArtifacts.listArtifacts(...) blootstellen, zodat begeleidende plugins geëxporteerde geheugenartefacten kunnen gebruiken via openclaw/plugin-sdk/memory-host-core in plaats van in de privélay-out van een specifieke geheugenplugin te grijpen.
• registerMemoryPromptSection, registerMemoryFlushPlan en registerMemoryRuntime zijn legacy-compatibele API’s voor exclusieve geheugenplugins.
• MemoryFlushPlan.model kan de flushbeurt vastzetten op een exacte provider/model- referentie, zoals ollama/qwen3:8b, zonder de actieve fallbackketen te erven.
• Met registerMemoryEmbeddingProvider kan de actieve geheugenplugin een of meer embeddingadapter-id’s registreren (bijvoorbeeld openai, gemini of een aangepaste door de plugin gedefinieerde id).
• Gebruikersconfiguratie zoals agents.defaults.memorySearch.provider en agents.defaults.memorySearch.fallback wordt opgelost tegen die geregistreerde adapter-id’s.

​

Gebeurtenissen en levenscyclus

​

Semantiek van hookbeslissingen

• before_tool_call: het retourneren van { block: true } is terminaal. Zodra een handler dit instelt, worden handlers met lagere prioriteit overgeslagen.
• before_tool_call: het retourneren van { block: false } wordt behandeld als geen beslissing (hetzelfde als block weglaten), niet als een override.
• before_install: het retourneren van { block: true } is terminaal. Zodra een handler dit instelt, worden handlers met lagere prioriteit overgeslagen.
• before_install: het retourneren van { block: false } wordt behandeld als geen beslissing (hetzelfde als block weglaten), niet als een override.
• reply_dispatch: het retourneren van { handled: true, ... } is terminaal. Zodra een handler de dispatch claimt, worden handlers met lagere prioriteit en het standaardpad voor modeldispatch overgeslagen.
• message_sending: het retourneren van { cancel: true } is terminaal. Zodra een handler dit instelt, worden handlers met lagere prioriteit overgeslagen.
• message_sending: het retourneren van { cancel: false } wordt behandeld als geen beslissing (hetzelfde als cancel weglaten), niet als een override.
• message_received: gebruik het getypte veld threadId wanneer je routering van inkomende threads/onderwerpen nodig hebt. Bewaar metadata voor kanaalspecifieke extra’s.
• message_sending: gebruik getypte routeringsvelden replyToId / threadId voordat je terugvalt op kanaalspecifieke metadata.
• gateway_start: gebruik ctx.config, ctx.workspaceDir en ctx.getCron?.() voor door de gateway beheerde opstartstatus in plaats van te vertrouwen op interne gateway:startup-hooks.
• cron_changed: observeer door de Gateway beheerde wijzigingen in de Cron-levenscyclus. Gebruik event.job?.state?.nextRunAtMs en ctx.getCron?.() bij het synchroniseren van externe wekschedulers, en behoud OpenClaw als de bron van waarheid voor vervalcontroles en uitvoering.

​

API-objectvelden

​

Interne moduleconventie

my-plugin/
  api.ts            # Public exports for external consumers
  runtime-api.ts    # Internal-only runtime exports
  index.ts          # Plugin entry point
  setup-entry.ts    # Lightweight setup-only entry (optional)

• Anthropic: openbare api.ts / contract-api.ts-seam voor Claude- helpers voor beta-header en service_tier-streams.
• @openclaw/openai-provider: api.ts exporteert providerbuilders, helpers voor standaardmodellen en realtime providerbuilders.
• @openclaw/openrouter-provider: api.ts exporteert de providerbuilder plus onboarding-/configuratiehelpers.

​

Gerelateerd