Skip to main content
SDK плагинов предоставляется в виде набора узких публичных подпутей в openclaw/plugin-sdk/. На этой странице перечислены часто используемые подпути, сгруппированные по назначению. Поверхность определяют три файла:
  • scripts/lib/plugin-sdk-entrypoints.json: поддерживаемый перечень точек входа, компилируемых при сборке.
  • scripts/lib/plugin-sdk-private-local-only-subpaths.json: локальные для репозитория тестовые и внутренние подпути. Экспорты пакета представляют собой перечень за вычетом этого списка.
  • src/plugin-sdk/entrypoints.ts: метаданные классификации для устаревших подпутей, зарезервированных встроенных вспомогательных средств, поддерживаемых встроенных фасадов и публичных поверхностей, принадлежащих плагинам.
Сопровождающие проверяют количество публичных экспортов с помощью pnpm plugin-sdk:surface, а активные зарезервированные подпути вспомогательных средств — с помощью pnpm plugins:boundary-report:summary; неиспользуемые экспорты зарезервированных вспомогательных средств приводят к сбою отчёта CI, а не остаются в публичном SDK в виде неактивного долга совместимости. Руководство по созданию плагинов см. в разделе Обзор SDK плагинов.

Точка входа плагина

Устаревшие средства совместимости и тестирования

Устаревшие подпути остаются экспортируемыми для старых плагинов, однако новый код должен использовать приведённые ниже специализированные подпути SDK. Поддерживаемый список находится в scripts/lib/plugin-sdk-deprecated-public-subpaths.json; CI отклоняет производственные импорты встроенных компонентов из него. Широкие агрегирующие модули, такие как plugin-sdk/compat, plugin-sdk/config-types, plugin-sdk/infra-runtime и plugin-sdk/text-runtime, предназначены только для совместимости, а plugin-sdk/zod является повторным экспортом для совместимости: импортируйте zod напрямую из zod. Широкие агрегирующие модули доменов plugin-sdk/agent-runtime, plugin-sdk/channel-lifecycle, plugin-sdk/channel-runtime, plugin-sdk/cli-runtime, plugin-sdk/conversation-runtime, plugin-sdk/hook-runtime, plugin-sdk/media-runtime, plugin-sdk/plugin-runtime и plugin-sdk/security-runtime также устарели; вместо них следует использовать специализированные подпути. Подпути вспомогательных средств тестирования OpenClaw на основе Vitest предназначены только для репозитория и больше не экспортируются из пакета: agent-runtime-test-contracts, channel-contract-testing, channel-target-testing, channel-test-helpers, plugin-state-test-runtime, plugin-test-api, plugin-test-contracts, plugin-test-runtime, provider-http-test-mocks, provider-test-contracts, reply-payload-testing, sqlite-runtime-testing, test-env, test-fixtures, test-node-mocks и testing. Закрытые поверхности встроенных вспомогательных средств ssrf-runtime-internal и codex-native-task-runtime также предназначены только для репозитория.

Зарезервированные подпути вспомогательных средств встроенных плагинов

plugin-sdk/codex-mcp-projection — единственный зарезервированный подпуть: принадлежащая плагину поверхность совместимости для встроенного плагина Codex, а не API SDK общего назначения. Импорты между плагинами разных владельцев блокируются средствами контроля контрактов пакетов, а CI завершается с ошибкой, если зарезервированный подпуть перестаёт импортироваться. plugin-sdk/codex-native-task-runtime предназначен только для репозитория и не экспортируется из пакета. src/plugin-sdk/entrypoints.ts также отслеживает поддерживаемые встроенные фасады — точки входа SDK, реализуемые соответствующим встроенным плагином до их замены универсальными контрактами: plugin-sdk/discord, plugin-sdk/lmstudio, plugin-sdk/lmstudio-runtime, plugin-sdk/matrix, plugin-sdk/mattermost, plugin-sdk/memory-core-engine-runtime, plugin-sdk/provider-zai-endpoint, plugin-sdk/qa-runner-runtime, plugin-sdk/telegram-account, plugin-sdk/tts-runtime и plugin-sdk/zalouser. Некоторые из них также устарели для нового кода; см. примечания к соответствующим строкам ниже.
Устаревшие семейства вспомогательных функций каналов остаются доступными только для совместимости опубликованных плагинов. План удаления: сохранить их на период миграции внешних плагинов, оставить плагины репозитория и встроенные плагины на channel-inbound и channel-outbound, а затем удалить подпути совместимости при следующей крупной очистке SDK. Это относится к устаревшим семействам сообщений/среды выполнения каналов, потоковой передачи каналов, прямого доступа к личным сообщениям, разрозненных вспомогательных функций для входящих сообщений, параметров ответа и путей сопряжения.
Снимки использования провайдеров обычно содержат одно или несколько окон квоты windows, каждое с меткой, процентом использования и необязательным временем сброса. Провайдеры, предоставляющие баланс или текст состояния учётной записи вместо сбрасываемых окон квоты, должны возвращать summary с пустым массивом windows, а не создавать вымышленные проценты. OpenClaw отображает этот сводный текст в выводе состояния; используйте error, только если конечная точка использования завершилась с ошибкой или не вернула пригодных данных об использовании.
Зарезервированные подпути SDK встроенных вспомогательных функций — это узкие поверхности, относящиеся к конкретным владельцам и предназначенные для кода встроенных плагинов. Они учитываются в инвентаре SDK, чтобы сборки пакетов и создание псевдонимов оставались детерминированными, но не являются API общего назначения для разработки плагинов. Новые переиспользуемые контракты хоста должны использовать общие подпути SDK, такие как plugin-sdk/gateway-runtime, plugin-sdk/ssrf-runtime и plugin-sdk/plugin-config-runtime.

Связанные материалы