Punkty wejścia Plugin

{
  "openclaw": {
    "extensions": ["./src/index.ts"],
    "runtimeExtensions": ["./dist/index.js"],
    "setupEntry": "./src/setup-entry.ts",
    "runtimeSetupEntry": "./dist/setup-entry.js"
  }
}

​

defineToolPlugin

import { Type } from "typebox";
import { defineToolPlugin } from "openclaw/plugin-sdk/tool-plugin";

export default defineToolPlugin({
  id: "stock-quotes",
  name: "Stock Quotes",
  description: "Fetch stock quotes.",
  configSchema: Type.Object({
    apiKey: Type.Optional(Type.String({ description: "API key." })),
  }),
  tools: (tool) => [
    tool({
      name: "quote",
      label: "Quote",
      description: "Fetch a quote.",
      parameters: Type.Object({
        symbol: Type.String({ description: "Ticker symbol." }),
      }),
      execute: async ({ symbol }, config) => ({ symbol, hasKey: Boolean(config.apiKey) }),
    }),
  ],
});

• configSchema jest opcjonalny. Po pominięciu OpenClaw używa ścisłego schematu pustego obiektu, a wygenerowany manifest nadal zawiera configSchema.
• execute zwraca zwykły ciąg znaków lub wartość możliwą do serializacji jako JSON. Funkcja pomocnicza opakowuje ją jako tekstowy wynik narzędzia z details.
• Nazwy narzędzi są statyczne. openclaw plugins build wyprowadza contracts.tools z zadeklarowanych narzędzi, więc autorzy nie duplikują nazw ręcznie.
• Ładowanie runtime pozostaje ścisłe. Zainstalowane pluginy nadal potrzebują openclaw.plugin.json i package.json openclaw.extensions; OpenClaw nie wykonuje kodu pluginu, aby wywnioskować brakujące dane manifestu.

​

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 musi pasować do manifestu openclaw.plugin.json.
• kind jest przeznaczone dla slotów wyłącznych: "memory" lub "context-engine".
• configSchema może być funkcją do leniwej ewaluacji.
• OpenClaw rozwiązuje i memoizuje ten schemat przy pierwszym dostępie, więc kosztowne konstruktory schematów uruchamiają się tylko raz.

​

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 jest wywoływane podczas rejestracji, aby można było zapisać referencję runtime (zwykle przez createPluginRuntimeStore). Jest pomijane podczas przechwytywania metadanych CLI.
• registerCliMetadata działa podczas api.registrationMode === "cli-metadata", api.registrationMode === "discovery" oraz api.registrationMode === "full". Używaj go jako kanonicznego miejsca na deskryptory CLI należące do kanału, aby pomoc główna pozostawała nieaktywująca, snapshoty wykrywania zawierały statyczne metadane poleceń, a normalna rejestracja poleceń CLI pozostawała zgodna z pełnymi ładowaniami pluginów.
• Rejestracja wykrywania jest nieaktywująca, a nie wolna od importów. OpenClaw może ewaluować zaufany wpis pluginu i moduł pluginu kanału, aby zbudować snapshot, więc utrzymuj importy najwyższego poziomu bez efektów ubocznych i umieszczaj sockety, klientów, workery i usługi za ścieżkami tylko dla "full".
• registerFull działa tylko wtedy, gdy api.registrationMode === "full". Jest pomijane podczas ładowania tylko setup.
• Podobnie jak definePluginEntry, configSchema może być leniwą fabryką, a OpenClaw memoizuje rozwiązany schemat przy pierwszym dostępie.
• Dla głównych poleceń CLI należących do pluginu preferuj api.registerCli(..., { descriptors: [...] }), gdy chcesz, aby polecenie pozostało ładowane leniwie bez znikania z głównego drzewa parsowania CLI. Dla poleceń funkcji sparowanych węzłów preferuj api.registerNodeCliFeature(...), aby polecenie trafiło pod openclaw nodes. Dla innych zagnieżdżonych poleceń pluginów dodaj parentPath i rejestruj polecenia na obiekcie program przekazanym do rejestratora; OpenClaw rozwiązuje go do polecenia nadrzędnego przed wywołaniem pluginu. Dla pluginów kanałów preferuj rejestrowanie tych deskryptorów z registerCliMetadata(...) i utrzymuj registerFull(...) skupione na pracy wyłącznie runtime.
• Jeśli registerFull(...) rejestruje także metody RPC Gateway, utrzymuj je na prefiksie specyficznym dla pluginu. Zarezerwowane główne przestrzenie nazw administracyjnych (config.*, exec.approvals.*, wizard.*, update.*) są zawsze wymuszane na operator.admin.

​

defineSetupPluginEntry

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

export default defineSetupPluginEntry(myChannelPlugin);

• openclaw/plugin-sdk/setup-runtime dla bezpiecznych w runtime pomocników setup, takich jak createSetupTranslator, bezpieczne dla importu adaptery poprawek setup, wyjście lookup-note, promptResolvedAllowFrom, splitSetupEntries i delegowane proxy setup
• openclaw/plugin-sdk/channel-setup dla powierzchni setup opcjonalnej instalacji
• openclaw/plugin-sdk/setup-tools dla pomocników setup/instalacji CLI/archiwum/dokumentacji

import { defineBundledChannelSetupEntry } from "openclaw/plugin-sdk/channel-entry-contract";

export default defineBundledChannelSetupEntry({
  importMetaUrl: import.meta.url,
  plugin: {
    specifier: "./channel-plugin-api.js",
    exportName: "myChannelPlugin",
  },
  runtime: {
    specifier: "./runtime-api.js",
    exportName: "setMyChannelRuntime",
  },
  registerSetupRuntime(api) {
    api.registerHttpRoute({
      path: "/my-channel/events",
      auth: "plugin",
      handler: async (req, res) => {
        /* setup-safe route */
      },
    });
  },
});

​

Tryb rejestracji

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

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

  // Heavy runtime-only registrations
  api.registerService(/* ... */);
}

• używaj descriptors, gdy rejestrator posiada jedno lub więcej poleceń głównych i chcesz, aby OpenClaw leniwie ładował rzeczywisty moduł CLI przy pierwszym wywołaniu
• upewnij się, że te deskryptory obejmują każdy główny korzeń polecenia udostępniany przez rejestrator
• ogranicz nazwy poleceń deskryptorów do liter, cyfr, łącznika i podkreślenia, zaczynając od litery lub cyfry; OpenClaw odrzuca nazwy deskryptorów spoza tego kształtu i usuwa sekwencje sterujące terminala z opisów przed renderowaniem pomocy
• używaj wyłącznie commands tylko dla ścieżek zgodności ładowanych od razu

​

Kształty Plugin

​

Powiązane

• Omówienie SDK - API rejestracji i referencja podścieżek
• Pomocniki runtime - api.runtime i createPluginRuntimeStore
• Konfiguracja i config - manifest, wejście konfiguracji, odroczone ładowanie
• Pluginy kanałów - budowanie obiektu ChannelPlugin
• Pluginy dostawców - rejestracja dostawcy i hooki