​

Manifest pluginu (openclaw.plugin.json)

• Pakiet Codex: .codex-plugin/plugin.json
• Pakiet Claude: .claude-plugin/plugin.json lub domyślny układ komponentów Claude bez manifestu
• Pakiet Cursor: .cursor-plugin/plugin.json

​

Do czego służy ten plik

• tożsamości pluginu
• walidacji konfiguracji
• metadanych uwierzytelniania i onboardingu, które powinny być dostępne bez uruchamiania środowiska uruchomieniowego pluginu
• metadanych aliasów i autoaktywacji, które powinny być rozstrzygane przed załadowaniem środowiska uruchomieniowego pluginu
• skróconych metadanych własności rodzin modeli, które powinny automatycznie aktywować plugin przed załadowaniem środowiska uruchomieniowego
• statycznych migawek własności możliwości używanych do dołączonego okablowania zgodności i pokrycia kontraktów
• metadanych konfiguracji specyficznych dla kanału, które powinny być scalane z powierzchniami katalogu i walidacji bez ładowania środowiska uruchomieniowego
• wskazówek interfejsu użytkownika dla konfiguracji

• rejestrowania zachowania środowiska uruchomieniowego
• deklarowania punktów wejścia kodu
• metadanych instalacji npm

​

Minimalny przykład

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

​

Rozbudowany przykład

{
  "id": "openrouter",
  "name": "OpenRouter",
  "description": "Plugin dostawcy OpenRouter",
  "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": "Klucz API OpenRouter",
      "groupId": "openrouter",
      "groupLabel": "OpenRouter",
      "optionKey": "openrouterApiKey",
      "cliFlag": "--openrouter-api-key",
      "cliOption": "--openrouter-api-key <key>",
      "cliDescription": "Klucz API OpenRouter",
      "onboardingScopes": ["text-inference"]
    }
  ],
  "uiHints": {
    "apiKey": {
      "label": "Klucz API",
      "placeholder": "sk-or-v1-...",
      "sensitive": true
    }
  },
  "configSchema": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "apiKey": {
        "type": "string"
      }
    }
  }
}

​

Odniesienie do pól najwyższego poziomu

​

Odniesienie do providerAuthChoices

​

Odniesienie do uiHints

{
  "uiHints": {
    "apiKey": {
      "label": "Klucz API",
      "help": "Używany do żądań OpenRouter",
      "placeholder": "sk-or-v1-...",
      "sensitive": true
    }
  }
}

​

Odniesienie do 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"]
  }
}

​

Odniesienie do channelConfigs

{
  "channelConfigs": {
    "matrix": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "homeserverUrl": { "type": "string" }
        }
      },
      "uiHints": {
        "homeserverUrl": {
          "label": "URL homeserwera",
          "placeholder": "https://matrix.example.com"
        }
      },
      "label": "Matrix",
      "description": "Połączenie z homeserwerem Matrix",
      "preferOver": ["matrix-legacy"]
    }
  }
}

​

Odniesienie do modelSupport

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

• jawne odwołania provider/model używają metadanych manifestu providers właściciela
• modelPatterns mają pierwszeństwo przed modelPrefixes
• jeśli jeden plugin niedołączony i jeden plugin dołączony pasują jednocześnie, wygrywa plugin niedołączony
• pozostała niejednoznaczność jest ignorowana, dopóki użytkownik lub konfiguracja nie określi dostawcy

​

Manifest a package.json

• jeśli OpenClaw musi znać go przed załadowaniem kodu pluginu, umieść go w openclaw.plugin.json
• jeśli dotyczy pakowania, plików wejściowych lub zachowania instalacji npm, umieść go w package.json

​

Pola package.json wpływające na wykrywanie

​

Wymagania dotyczące schematu JSON

• Każdy plugin musi dostarczać schemat JSON, nawet jeśli nie przyjmuje żadnej konfiguracji.
• Pusty schemat jest akceptowalny (na przykład { "type": "object", "additionalProperties": false }).
• Schematy są walidowane podczas odczytu/zapisu konfiguracji, a nie w czasie działania.

​

Zachowanie walidacji

• Nieznane klucze channels.* są błędami, chyba że identyfikator kanału został zadeklarowany przez manifest pluginu.
• plugins.entries.<id>, plugins.allow, plugins.deny i plugins.slots.* muszą odwoływać się do wykrywalnych identyfikatorów pluginów. Nieznane identyfikatory są błędami.
• Jeśli plugin jest zainstalowany, ale ma uszkodzony lub brakujący manifest albo schemat, walidacja kończy się niepowodzeniem, a Doctor zgłasza błąd pluginu.
• Jeśli konfiguracja pluginu istnieje, ale plugin jest wyłączony, konfiguracja jest zachowywana, a w Doctor + logach pojawia się ostrzeżenie.

​

Uwagi

• Manifest jest wymagany dla natywnych pluginów OpenClaw, w tym dla ładowań z lokalnego systemu plików.
• Środowisko uruchomieniowe nadal ładuje moduł pluginu oddzielnie; manifest służy wyłącznie do wykrywania + walidacji.
• Natywne manifesty są analizowane za pomocą JSON5, więc komentarze, końcowe przecinki i klucze bez cudzysłowów są akceptowane, o ile końcowa wartość nadal jest obiektem.
• Moduł ładujący manifest odczytuje tylko udokumentowane pola manifestu. Unikaj dodawania tutaj niestandardowych kluczy najwyższego poziomu.
• providerAuthEnvVars to lekka ścieżka metadanych dla sond uwierzytelniania, walidacji znaczników zmiennych środowiskowych i podobnych powierzchni uwierzytelniania dostawcy, które nie powinny uruchamiać środowiska uruchomieniowego pluginu tylko po to, aby sprawdzić nazwy zmiennych środowiskowych.
• providerAuthChoices to lekka ścieżka metadanych dla selektorów wyboru uwierzytelniania, rozstrzygania --auth-choice, mapowania preferowanego dostawcy i prostej rejestracji flag CLI w onboardingu przed załadowaniem środowiska uruchomieniowego dostawcy. Informacje o metadanych kreatora środowiska uruchomieniowego, które wymagają kodu dostawcy, znajdziesz w hookach środowiska uruchomieniowego dostawcy.
• Wyłączne rodzaje pluginów są wybierane przez plugins.slots.*.
  • kind: "memory" jest wybierany przez plugins.slots.memory.
  • kind: "context-engine" jest wybierany przez plugins.slots.contextEngine (domyślnie: wbudowany legacy).
• channels, providers, cliBackends i skills można pominąć, gdy plugin ich nie potrzebuje.
• Jeśli twój plugin zależy od modułów natywnych, opisz kroki budowania i wszelkie wymagania dotyczące listy dozwolonych menedżera pakietów (na przykład pnpm allow-build-scripts
  • pnpm rebuild <package>).

​

Powiązane

• Tworzenie pluginów — jak zacząć pracę z pluginami
• Architektura pluginów — architektura wewnętrzna
• Przegląd SDK — odniesienie do Plugin SDK