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 वैकल्पिक है। छोड़े जाने पर, OpenClaw strict empty object schema का उपयोग करता है और generated manifest में फिर भी configSchema शामिल होता है।
• execute साधारण string या JSON-serializable value लौटाता है। helper इसे details के साथ text tool result के रूप में wrap करता है।
• Tool names static होते हैं। openclaw plugins build घोषित tools से contracts.tools निकालता है, इसलिए authors को names हाथ से duplicate नहीं करने पड़ते।
• Runtime loading strict रहती है। इंस्टॉल किए गए plugins को अभी भी openclaw.plugin.json और package.json openclaw.extensions चाहिए; OpenClaw गायब manifest data का अनुमान लगाने के लिए plugin code execute नहीं करता।

​

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 को आपके openclaw.plugin.json manifest से मेल खाना चाहिए।
• kind exclusive slots के लिए है: "memory" या "context-engine"।
• configSchema lazy evaluation के लिए function हो सकता है।
• OpenClaw पहली access पर उस schema को resolve और memoize करता है, इसलिए महंगे schema builders केवल एक बार चलते हैं।

​

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 registration के दौरान call किया जाता है ताकि आप runtime reference store कर सकें (आमतौर पर createPluginRuntimeStore के जरिए)। CLI metadata capture के दौरान इसे skip किया जाता है।
• registerCliMetadata api.registrationMode === "cli-metadata", api.registrationMode === "discovery", और api.registrationMode === "full" के दौरान चलता है। इसे channel-owned CLI descriptors के canonical स्थान के रूप में उपयोग करें, ताकि root help non-activating रहे, discovery snapshots में static command metadata शामिल हो, और normal CLI command registration full plugin loads के साथ compatible रहे।
• Discovery registration non-activating है, import-free नहीं। OpenClaw snapshot बनाने के लिए trusted plugin entry और channel plugin module evaluate कर सकता है, इसलिए top-level imports को side-effect-free रखें और sockets, clients, workers, और services को "full"-only paths के पीछे रखें।
• registerFull केवल तब चलता है जब api.registrationMode === "full"। setup-only loading के दौरान इसे skip किया जाता है।
• definePluginEntry की तरह, configSchema lazy factory हो सकता है और OpenClaw पहली access पर resolved schema को memoize करता है।
• Plugin-owned root CLI commands के लिए, जब आप चाहते हैं कि command root CLI parse tree से गायब हुए बिना lazy-loaded रहे, तो api.registerCli(..., { descriptors: [...] }) को प्राथमिकता दें। paired-node feature commands के लिए, api.registerNodeCliFeature(...) को प्राथमिकता दें ताकि command openclaw nodes के नीचे आए। अन्य nested plugin commands के लिए, parentPath जोड़ें और registrar को दिए गए program object पर commands register करें; OpenClaw plugin को call करने से पहले इसे parent command में resolve करता है। channel plugins के लिए, उन descriptors को registerCliMetadata(...) से register करना पसंद करें और registerFull(...) को runtime-only work पर केंद्रित रखें।
• यदि registerFull(...) gateway RPC methods भी register करता है, तो उन्हें plugin-specific prefix पर रखें। Reserved core admin namespaces (config.*, exec.approvals.*, wizard.*, update.*) हमेशा operator.admin में coerced किए जाते हैं।

​

defineSetupPluginEntry

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

export default defineSetupPluginEntry(myChannelPlugin);

• runtime-safe setup helpers जैसे createSetupTranslator, import-safe setup patch adapters, lookup-note output, promptResolvedAllowFrom, splitSetupEntries, और delegated setup proxies के लिए openclaw/plugin-sdk/setup-runtime
• optional-install setup surfaces के लिए openclaw/plugin-sdk/channel-setup
• setup/install CLI/archive/docs helpers के लिए openclaw/plugin-sdk/setup-tools

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

​

Registration mode

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(/* ... */);
}

• जब रजिस्ट्रार एक या अधिक रूट कमांड का स्वामी हो और आप चाहते हों कि OpenClaw पहली बार चलाने पर असली CLI मॉड्यूल को लेज़ी-लोड करे, तब descriptors का उपयोग करें
• सुनिश्चित करें कि वे डिस्क्रिप्टर रजिस्ट्रार द्वारा उजागर किए गए हर टॉप-लेवल कमांड रूट को कवर करते हों
• डिस्क्रिप्टर कमांड नामों को अक्षरों, संख्याओं, हाइफ़न और अंडरस्कोर तक सीमित रखें, और उन्हें किसी अक्षर या संख्या से शुरू करें; OpenClaw इस आकार से बाहर के डिस्क्रिप्टर नामों को अस्वीकार करता है और सहायता रेंडर करने से पहले विवरणों से टर्मिनल कंट्रोल सीक्वेंस हटा देता है
• केवल उत्सुक संगतता पाथ के लिए ही commands अकेले उपयोग करें

​

Plugin आकार

​

संबंधित

• SDK अवलोकन - रजिस्ट्रेशन API और सबपाथ संदर्भ
• रनटाइम हेल्पर - api.runtime और createPluginRuntimeStore
• सेटअप और कॉन्फ़िग - मैनिफ़ेस्ट, सेटअप एंट्री, स्थगित लोडिंग
• चैनल Plugins - ChannelPlugin ऑब्जेक्ट बनाना
• प्रोवाइडर Plugins - प्रोवाइडर रजिस्ट्रेशन और हुक