​

Маніфест плагіна (openclaw.plugin.json)

• Codex bundle: .codex-plugin/plugin.json
• Claude bundle: .claude-plugin/plugin.json або типовий макет компонента Claude без маніфесту
• Cursor bundle: .cursor-plugin/plugin.json

​

Що робить цей файл

• ідентичності плагіна
• валідації конфігурації
• метаданих автентифікації та онбордингу, які мають бути доступні без запуску середовища виконання плагіна
• метаданих псевдонімів і автоувімкнення, які мають визначатися до завантаження середовища виконання плагіна
• скорочених метаданих про належність до сімейства моделей, які мають автоматично активувати плагін до завантаження середовища виконання
• статичних знімків належності можливостей, що використовуються для вбудованої compat-wiring і покриття контрактів
• метаданих конфігурації каналу, які мають об’єднуватися в поверхні каталогу та валідації без завантаження середовища виконання
• підказок UI для конфігурації

• реєстрації поведінки середовища виконання
• оголошення entrypoint коду
• метаданих встановлення npm

​

Мінімальний приклад

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

​

Розширений приклад

{
  "id": "openrouter",
  "name": "OpenRouter",
  "description": "OpenRouter provider plugin",
  "version": "1.0.0",
  "providers": ["openrouter"],
  "modelSupport": {
    "modelPrefixes": ["router-"]
  },
  "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"
      }
    }
  }
}

​

Довідник полів верхнього рівня

​

Довідник providerAuthChoices

​

Довідник uiHints

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

​

Довідник 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"]
  }
}

​

Довідник 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"]
    }
  }
}

​

Довідник modelSupport

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

• явні посилання provider/model використовують метадані маніфесту providers, що визначають власника
• modelPatterns мають пріоритет над modelPrefixes
• якщо збігаються один невбудований і один вбудований плагін, перемагає невбудований плагін
• решта неоднозначностей ігнорується, доки користувач або конфігурація не вкаже провайдера

​

Маніфест проти package.json

• якщо OpenClaw має знати це до завантаження коду плагіна, помістіть це в openclaw.plugin.json
• якщо це стосується пакування, entry-файлів або поведінки npm install, помістіть це в package.json

​

Поля package.json, що впливають на виявлення

​

Вимоги до JSON Schema

• Кожен плагін має постачатися з JSON Schema, навіть якщо він не приймає конфігурацію.
• Порожня schema допустима (наприклад, { "type": "object", "additionalProperties": false }).
• Schema проходять валідацію під час читання/запису конфігурації, а не під час виконання.

​

Поведінка валідації

• Невідомі ключі channels.* є помилками, якщо тільки id каналу не оголошено в маніфесті плагіна.
• plugins.entries.<id>, plugins.allow, plugins.deny і plugins.slots.* мають посилатися на виявлювані id плагінів. Невідомі id є помилками.
• Якщо плагін установлено, але він має зламаний або відсутній маніфест чи schema, валідація завершується помилкою, а Doctor повідомляє про помилку плагіна.
• Якщо конфігурація плагіна існує, але сам плагін вимкнений, конфігурація зберігається, і у Doctor + журналах з’являється попередження.

​

Примітки

• Маніфест обов’язковий для власних плагінів OpenClaw, зокрема при локальному завантаженні з файлової системи.
• Середовище виконання й надалі завантажує модуль плагіна окремо; маніфест використовується лише для виявлення + валідації.
• Власні маніфести розбираються за допомогою JSON5, тож коментарі, кінцеві коми й ключі без лапок допускаються, якщо кінцеве значення все ще є об’єктом.
• Завантажувач маніфесту зчитує лише документовані поля маніфесту. Не додавайте сюди власні ключі верхнього рівня.
• providerAuthEnvVars — це недорогий шлях метаданих для перевірок автентифікації, валідації env-маркерів та подібних поверхонь автентифікації провайдера, які не повинні запускати середовище виконання плагіна лише для перевірки назв env.
• providerAuthChoices — це недорогий шлях метаданих для пікерів варіантів автентифікації, визначення --auth-choice, мапінгу бажаного провайдера та простої реєстрації CLI-прапорців онбордингу до завантаження середовища виконання провайдера. Для метаданих майстра середовища виконання, які потребують коду провайдера, див. Хуки середовища виконання провайдера.
• Ексклюзивні типи плагінів вибираються через plugins.slots.*.
  • kind: "memory" вибирається через plugins.slots.memory.
  • kind: "context-engine" вибирається через plugins.slots.contextEngine (типово: вбудований legacy).
• channels, providers і skills можна опускати, якщо плагіну вони не потрібні.
• Якщо ваш плагін залежить від native modules, задокументуйте кроки збирання та всі вимоги до allowlist менеджера пакетів (наприклад, pnpm allow-build-scripts
  • pnpm rebuild <package>).

​

Пов’язане

• Створення плагінів — початок роботи з плагінами
• Архітектура плагінів — внутрішня архітектура
• Огляд SDK — довідник з Plugin SDK