Desenvolvimento de plugins

openclaw plugins install clawhub:<package-name>

​

Requisitos

• Node 22.22.3+, Node 24.15+ ou Node 25.9+, e npm ou pnpm.
• Módulos ESM TypeScript.
• Para trabalhar em um plugin incluído no repositório, clone o repositório e execute pnpm install. O desenvolvimento de plugins no checkout do código-fonte usa somente pnpm porque o OpenClaw descobre plugins incluídos nos pacotes do workspace extensions/*.

​

Escolha o formato do plugin

​

Início rápido

{
  "name": "@myorg/openclaw-my-plugin",
  "version": "1.0.0",
  "type": "module",
  "dependencies": {
    "typebox": "1.1.39"
  },
  "peerDependencies": {
    "openclaw": ">=2026.3.24-beta.2"
  },
  "openclaw": {
    "extensions": ["./index.ts"],
    "compat": {
      "pluginApi": ">=2026.3.24-beta.2",
      "minGatewayVersion": "2026.3.24-beta.2"
    },
    "build": {
      "openclawVersion": "2026.3.24-beta.2",
      "pluginSdkVersion": "2026.3.24-beta.2"
    }
  }
}

{
  "id": "my-plugin",
  "name": "My Plugin",
  "description": "Adds a custom tool to OpenClaw",
  "contracts": {
    "tools": ["my_tool"]
  },
  "activation": {
    "onStartup": true
  },
  "configSchema": {
    "type": "object",
    "additionalProperties": false
  }
}

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

export default definePluginEntry({
  id: "my-plugin",
  name: "My Plugin",
  description: "Adds a custom tool to OpenClaw",
  register(api) {
    api.registerTool({
      name: "my_tool",
      description: "Echo one input value",
      parameters: Type.Object({ input: Type.String() }),
      async execute(_id, params) {
        return {
          content: [{ type: "text", text: `Got: ${params.input}` }],
        };
      },
    });
  },
});

openclaw plugins inspect my-plugin --runtime --json

pnpm test extensions/my-plugin/
pnpm check

npm pack --pack-destination /tmp
openclaw plugins install npm-pack:/tmp/<plugin-package>.tgz --force
openclaw plugins inspect my-plugin --runtime --json

clawhub package publish your-org/your-plugin --dry-run
clawhub package publish your-org/your-plugin

openclaw plugins install clawhub:your-org/your-plugin

​

Registro de ferramentas

register(api) {
  api.registerTool(
    {
      name: "workflow_tool",
      description: "Run a workflow",
      parameters: Type.Object({ pipeline: Type.String() }),
      async execute(_id, params) {
        return { content: [{ type: "text", text: params.pipeline }] };
      },
    },
    { optional: true },
  );
}

{
  "contracts": {
    "tools": ["workflow_tool"]
  },
  "toolMetadata": {
    "workflow_tool": {
      "optional": true
    }
  }
}

{
  tools: { allow: ["workflow_tool"] }, // or ["my-plugin"] for every tool from one plugin
}

​

Convenções de importação

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

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

​

Lista de verificação antes do envio

​

Teste com versões beta

1. Acompanhe as versões de openclaw/openclaw (Watch > Releases). As tags beta têm a seguinte aparência: v2026.3.N-beta.1. Também é possível seguir @openclaw no X para receber anúncios de versões.
2. Teste seu plugin com a tag beta assim que ela aparecer. O intervalo antes da versão estável normalmente é de apenas algumas horas.
3. Após os testes, publique na thread do seu plugin no canal plugin-forum do Discord (discord.gg/clawd), informando all good ou o que deixou de funcionar. Crie uma thread caso ainda não tenha uma.
4. Se algo deixar de funcionar, abra ou atualize uma issue com o título Beta blocker: <plugin-name> - <summary> e aplique o rótulo beta-blocker. Inclua o link da issue na sua thread.
5. Abra um PR para main com o título fix(<plugin-id>): beta blocker - <summary> e inclua o link da issue tanto no PR quanto na sua thread do Discord. Colaboradores não podem aplicar rótulos a PRs, portanto o título é o sinal no PR para os mantenedores e a automação. Bloqueios com um PR são mesclados; bloqueios sem um PR podem acabar sendo lançados mesmo assim.
6. O silêncio indica que está tudo certo. Perder o prazo normalmente significa que sua correção será incluída no próximo ciclo.

​

Próximas etapas

​

Relacionados

• Hooks de plugin
• Arquitetura de plugins