Use this file to discover all available pages before exploring further.

Plugin SDK subpaths

The plugin SDK is exposed as a set of narrow subpaths under

text

openclaw/plugin-sdk/

. This page catalogs the commonly used subpaths grouped by purpose. The generated full list of 200+ subpaths lives in

text

scripts/lib/plugin-sdk-entrypoints.json

; reserved bundled-plugin helper subpaths appear there but are implementation detail unless a doc page explicitly promotes them. Maintainers can audit active reserved helper subpaths with

text

pnpm plugins:boundary-report:summary

; unused reserved helper exports fail the CI report instead of staying in the public SDK as dormant compatibility debt.

For the plugin authoring guide, see Plugin SDK overview.

Plugin entry

Subpath	Key exports
text `plugin-sdk/plugin-entry`	text `definePluginEntry`
text `plugin-sdk/core`	text `defineChannelPluginEntry` , text `createChatChannelPlugin` , text `createChannelPluginBase` , text `defineSetupPluginEntry` , text `buildChannelConfigSchema`
text `plugin-sdk/config-schema`	text `OpenClawSchema`
text `plugin-sdk/provider-entry`	text `defineSingleProviderPluginEntry`
text `plugin-sdk/testing`	Broad compatibility barrel for legacy plugin tests; prefer focused test subpaths for new extension tests
text `plugin-sdk/plugin-test-api`	Minimal text `OpenClawPluginApi` mock builder for direct plugin registration unit tests
text `plugin-sdk/agent-runtime-test-contracts`	Native agent-runtime adapter contract fixtures for auth profiles, delivery suppression, fallback classification, tool hooks, prompt overlays, schemas, and transcript repair
text `plugin-sdk/channel-test-helpers`	Channel account lifecycle, directory, send-config, runtime mock, hook, bundled channel entry, envelope timestamp, pairing reply, and generic channel contract test helpers
text `plugin-sdk/channel-target-testing`	Shared channel target-resolution error-case test suite
text `plugin-sdk/plugin-test-contracts`	Plugin registration, package manifest, public artifact, runtime API, import side-effect, and direct import contract helpers
text `plugin-sdk/plugin-test-runtime`	Plugin runtime, registry, provider-registration, setup-wizard, and runtime task-flow fixtures for tests
text `plugin-sdk/provider-test-contracts`	Provider runtime, auth, discovery, onboard, catalog, media capability, replay policy, realtime STT live-audio, web-search/fetch, and wizard contract helpers
text `plugin-sdk/provider-http-test-mocks`	Opt-in Vitest HTTP/auth mocks for provider tests that exercise text `plugin-sdk/provider-http`
text `plugin-sdk/test-env`	Test environment, fetch/network, disposable HTTP server, incoming request, live-test, temporary filesystem, and time-control fixtures
text `plugin-sdk/test-fixtures`	Generic CLI, sandbox, skill, agent-message, system-event, module reload, bundled plugin path, terminal, chunking, auth-token, and typed-case test fixtures
text `plugin-sdk/test-node-mocks`	Focused Node builtin mock helpers for use inside Vitest text `vi.mock("node:*")` factories
text `plugin-sdk/migration`	Migration provider item helpers such as text `createMigrationItem` , reason constants, item status markers, redaction helpers, and text `summarizeMigrationItems`
text `plugin-sdk/migration-runtime`	Runtime migration helpers such as text `copyMigrationFileItem` , text `withCachedMigrationConfigRuntime` , and text `writeMigrationReport`

OpenClaw Docs

Plugin SDK subpaths

Plugin entry

Related