​

Manifesto de plugin (openclaw.plugin.json)

• Bundle Codex: .codex-plugin/plugin.json
• Bundle Claude: .claude-plugin/plugin.json ou o layout padrão de componente do Claude sem manifesto
• Bundle Cursor: .cursor-plugin/plugin.json

​

O que este arquivo faz

• identidade do plugin
• validação de configuração
• metadados de autenticação e onboarding que devem estar disponíveis sem iniciar o runtime do plugin
• metadados de alias e ativação automática que devem ser resolvidos antes de o runtime do plugin carregar
• metadados abreviados de propriedade de família de modelos que devem ativar automaticamente o plugin antes de o runtime carregar
• snapshots estáticos de propriedade de capacidades usados para o wiring de compatibilidade empacotada e cobertura de contratos
• metadados de configuração específicos de canal que devem ser mesclados às superfícies de catálogo e validação sem carregar o runtime
• dicas de UI de configuração

• registrar comportamento de runtime
• declarar entrypoints de código
• metadados de instalação npm

​

Exemplo mínimo

{
  "id": "voice-call",
  "configSchema": {
    "type": "object",
    "additionalProperties": false,
    "properties": {}
  }
}

​

Exemplo completo

{
  "id": "openrouter",
  "name": "OpenRouter",
  "description": "OpenRouter provider plugin",
  "version": "1.0.0",
  "providers": ["openrouter"],
  "modelSupport": {
    "modelPrefixes": ["router-"]
  },
  "cliBackends": ["openrouter-cli"],
  "providerAuthEnvVars": {
    "openrouter": ["OPENROUTER_API_KEY"]
  },
  "providerAuthChoices": [
    {
      "provider": "openrouter",
      "method": "api-key",
      "choiceId": "openrouter-api-key",
      "choiceLabel": "OpenRouter API key",
      "groupId": "openrouter",
      "groupLabel": "OpenRouter",
      "optionKey": "openrouterApiKey",
      "cliFlag": "--openrouter-api-key",
      "cliOption": "--openrouter-api-key <key>",
      "cliDescription": "OpenRouter API key",
      "onboardingScopes": ["text-inference"]
    }
  ],
  "uiHints": {
    "apiKey": {
      "label": "API key",
      "placeholder": "sk-or-v1-...",
      "sensitive": true
    }
  },
  "configSchema": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "apiKey": {
        "type": "string"
      }
    }
  }
}

​

Referência de campos de nível superior

​

Referência de providerAuthChoices

​

Referência de uiHints

{
  "uiHints": {
    "apiKey": {
      "label": "API key",
      "help": "Used for OpenRouter requests",
      "placeholder": "sk-or-v1-...",
      "sensitive": true
    }
  }
}

​

Referência de contracts

{
  "contracts": {
    "speechProviders": ["openai"],
    "realtimeTranscriptionProviders": ["openai"],
    "realtimeVoiceProviders": ["openai"],
    "mediaUnderstandingProviders": ["openai", "openai-codex"],
    "imageGenerationProviders": ["openai"],
    "videoGenerationProviders": ["qwen"],
    "webFetchProviders": ["firecrawl"],
    "webSearchProviders": ["gemini"],
    "tools": ["firecrawl_search", "firecrawl_scrape"]
  }
}

​

Referência de channelConfigs

{
  "channelConfigs": {
    "matrix": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "homeserverUrl": { "type": "string" }
        }
      },
      "uiHints": {
        "homeserverUrl": {
          "label": "Homeserver URL",
          "placeholder": "https://matrix.example.com"
        }
      },
      "label": "Matrix",
      "description": "Matrix homeserver connection",
      "preferOver": ["matrix-legacy"]
    }
  }
}

​

Referência de modelSupport

{
  "modelSupport": {
    "modelPrefixes": ["gpt-", "o1", "o3", "o4"],
    "modelPatterns": ["^computer-use-preview"]
  }
}

• referências explícitas provider/model usam os metadados do manifesto providers proprietário
• modelPatterns têm prioridade sobre modelPrefixes
• se um plugin não empacotado e um plugin empacotado corresponderem, o plugin não empacotado vence
• a ambiguidade restante é ignorada até que o usuário ou a configuração especifique um provedor

​

Manifesto versus package.json

• se o OpenClaw precisa conhecê-lo antes de carregar o código do plugin, coloque-o em openclaw.plugin.json
• se ele trata de empacotamento, arquivos de entrada ou comportamento de instalação npm, coloque-o em package.json

​

Campos de package.json que afetam a descoberta

​

Requisitos de JSON Schema

• Todo plugin deve incluir um JSON Schema, mesmo que ele não aceite configuração.
• Um esquema vazio é aceitável (por exemplo, { "type": "object", "additionalProperties": false }).
• Esquemas são validados no momento da leitura/gravação da configuração, não em runtime.

​

Comportamento de validação

• Chaves desconhecidas em channels.* são erros, a menos que o ID do canal seja declarado por um manifesto de plugin.
• plugins.entries.<id>, plugins.allow, plugins.deny e plugins.slots.* devem referenciar IDs de plugin detectáveis. IDs desconhecidos são erros.
• Se um plugin estiver instalado, mas tiver um manifesto ou esquema quebrado ou ausente, a validação falha e o Doctor informa o erro do plugin.
• Se a configuração do plugin existir, mas o plugin estiver desabilitado, a configuração será mantida e um aviso será exibido no Doctor + logs.

​

Observações

• O manifesto é obrigatório para plugins nativos do OpenClaw, incluindo carregamentos do sistema de arquivos local.
• O runtime ainda carrega o módulo do plugin separadamente; o manifesto é apenas para descoberta + validação.
• Manifestos nativos são analisados com JSON5, então comentários, vírgulas à direita e chaves sem aspas são aceitos, desde que o valor final ainda seja um objeto.
• Apenas os campos de manifesto documentados são lidos pelo carregador de manifesto. Evite adicionar chaves personalizadas de nível superior aqui.
• providerAuthEnvVars é o caminho barato de metadados para sondagens de autenticação, validação de marcadores de env e superfícies semelhantes de autenticação de provedor que não devem iniciar o runtime do plugin apenas para inspecionar nomes de env.
• providerAuthChoices é o caminho barato de metadados para seletores de escolha de autenticação, resolução de --auth-choice, mapeamento de provedor preferido e registro simples de flags de onboarding da CLI antes de o runtime do provedor carregar. Para metadados de assistente de runtime que exigem código do provedor, consulte Hooks de runtime do provedor.
• Tipos exclusivos de plugin são selecionados por plugins.slots.*.
  • kind: "memory" é selecionado por plugins.slots.memory.
  • kind: "context-engine" é selecionado por plugins.slots.contextEngine (padrão: legacy integrado).
• channels, providers, cliBackends e skills podem ser omitidos quando um plugin não precisa deles.
• Se o seu plugin depender de módulos nativos, documente as etapas de build e quaisquer requisitos de allowlist do gerenciador de pacotes (por exemplo, allow-build-scripts do pnpm
  • pnpm rebuild <package>).

​

Relacionado

• Criando Plugins — primeiros passos com plugins
• Arquitetura de Plugins — arquitetura interna
• Visão geral do SDK — referência do SDK de Plugin