Plugin SDK reference
Plugin SDK subpaths
The plugin SDK contains narrow public subpaths and repository-only bundled
helpers under openclaw/plugin-sdk/. This page catalogs every typed public
subpath and labels selected private-local entries explicitly; it is not an
inventory of every internal runtime helper. Four files define the boundary:
scripts/lib/plugin-sdk-entrypoints.json: the maintained entrypoint inventory the build compiles.scripts/lib/plugin-sdk-private-local-only-subpaths.json: internal subpaths excluded from the typed, documented SDK. Production entries remain available as JavaScript-only host runtime exports for separately published official plugins; test-only entries stay unexported.scripts/lib/plugin-sdk-deprecated-public-subpaths.json: public compatibility subpaths retained only through their documented removal windows.scripts/lib/plugin-sdk-entries.mts: derived public/private export metadata, supported bundled facades, and plugin-owned public surfaces.
After changing the entrypoint inventories, run pnpm plugin-sdk:sync-exports,
then pnpm plugin-sdk:check-exports. The same registration command maintains
package exports, private artifact exclusions in package.json's files, and
private workspace declaration aliases in
extensions/tsconfig.package-boundary.paths.json and extensions/xai/tsconfig.json.
It owns literal flat !dist/plugin-sdk/<name>.js and .d.ts exclusions, including
names with underscores, uppercase letters, dots, or Unicode, and removes obsolete
exclusions when entries become public or are removed. Nested paths, glob or escape
syntax, non-entrypoint metadata, and other file rules retain their order; unrelated
mappings and XAI's intentional private-alias omissions are preserved.
These local declaration aliases do not add types to JavaScript-only published
SDK exports; test-only entries remain unexported.
Maintainers audit the public export count with pnpm plugin-sdk:surface and
the compatibility queue with pnpm plugins:boundary-report:summary.
For the plugin authoring guide, see Plugin SDK overview.
Plugin entry
Native feature authoring uses plugin-sdk/feature-contract
(defineFeatureContract, createFeatureClient), plugin-sdk/feature-plugin
(defineFeaturePlugin), and plugin-sdk/control-ui (defineControlUiPlugin,
host and view types). The contract and Control UI subpaths are browser safe;
feature-plugin is backend only. See Feature plugins.
| Subpath | Key exports |
|---|---|
plugin-sdk/plugin-entry |
definePluginEntry, PluginCapabilityCatalog, PluginCapabilityCatalogEntry, PluginCapabilityCatalogContext |
plugin-sdk/core |
defineChannelPluginEntry, createChatChannelPlugin, createChannelPluginBase, defineSetupPluginEntry, buildChannelConfigSchema, buildJsonChannelConfigSchema, resolveTailscalePublishedHost |
plugin-sdk/provider-entry |
Private-local after July 2026; defineSingleProviderPluginEntry |
plugin-sdk/migration |
Private-local after July 2026; Migration provider item helpers such as createMigrationItem, reason constants, item status markers, redaction helpers, and summarizeMigrationItems |
plugin-sdk/migration-runtime |
Private-local after July 2026; Runtime migration helpers such as copyMigrationFileItem, resolvePlannedMigrationTargets, withCachedMigrationConfigRuntime, and writeMigrationReport |
plugin-sdk/health |
Doctor health-check registration, detection, repair, selection, severity, and finding types for bundled health consumers |
plugin-sdk/channel-entry-contract |
Bundled channel entry and setup-entry contracts, feature declarations, and lazy module-loading helpers |
Capability catalog entry
A manifest's capabilityCatalogEntry default export satisfies
PluginCapabilityCatalogEntry from openclaw/plugin-sdk/plugin-entry:
import type { PluginCapabilityCatalogEntry } from "openclaw/plugin-sdk/plugin-entry";import { buildSpeechProvider } from "./speech-provider.js"; export default { speechProviders: [buildSpeechProvider()],} satisfies PluginCapabilityCatalogEntry;The optional collections are speechProviders, realtimeTranscriptionProviders,
and realtimeVoiceProviders. Use the same provider factories as full registration;
retain their configuration, aliases, readiness functions, execution methods, and
non-enumerable internal methods. The host registers descriptors through the normal
registrar, preserving its ownership and registration lifecycle.
The export may instead be a synchronous factory receiving
PluginCapabilityCatalogContext. It supplies native host operations for readiness,
auth resolution, provider headers, bounded HTTP responses, WebSocket transcription,
and capture/logging. Pass the operations used by a provider into its shared factory;
keep synchronous constructors and invoke the operations only when needed. This
avoids transforming host runtime modules through the plugin source loader during
catalog construction or connection setup. Construction must not query auth stores,
start sessions, or import broad host or plugin runtime modules. Cold discovery does
not receive a live broker; active registrations retain their broker-bound behavior.
See manifest capability catalogs for family coverage, compatibility, artifact selection, and failure behavior.
Compatibility and private-local helpers
Deprecated compatibility subpaths remain exported under their recorded windows
and retention blockers. July 2026 aliases and unused subpaths were deleted,
while bundled-only helpers were excluded from the typed public SDK and are
labeled private-local below. Production-private JavaScript exports remain
available for official plugin runtimes. The maintained list is
scripts/lib/plugin-sdk-deprecated-public-subpaths.json; CI rejects bundled
imports of these compatibility-only subpaths. The broad domain barrels
plugin-sdk/agent-runtime, plugin-sdk/channel-lifecycle,
plugin-sdk/conversation-runtime, plugin-sdk/hook-runtime,
plugin-sdk/media-runtime, plugin-sdk/plugin-runtime, and
plugin-sdk/security-runtime are likewise deprecated in favor of focused
subpaths.
OpenClaw's Vitest-backed test-helper subpaths are repo-local only and are no
longer package exports: 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-live, test-live-auth, test-media-generation,
test-media-understanding, test-node-mocks, and testing.
ssrf-runtime-internal is a JavaScript-only host runtime reserved for exact
trusted local-service plugins; it is not a public plugin authoring API.
Bundled plugin helper subpaths
Bundled-only helper modules are private-local after the July 2026 sweep. Package contract guardrails classify the supported bundled facades that remain public until generic contracts replace them. Those facades are deprecated for new code; see the per-row notes below.
Channel subpaths
| Subpath | Key exports |
|---|---|
plugin-sdk/channel-core |
defineChannelPluginEntry, defineSetupPluginEntry, createChatChannelPlugin, createChannelPluginBase, createChannelConfigUiHints |
plugin-sdk/json-schema-runtime |
Private-local after July 2026; Cached JSON Schema validation helper for plugin-owned schemas |
plugin-sdk/channel-setup |
defineChannelSetupContract, channel-owned setup field/input types, createOptionalChannelSetupSurface, createOptionalChannelSetupAdapter, createOptionalChannelSetupWizard, plus DEFAULT_ACCOUNT_ID, createTopLevelChannelDmPolicy, setSetupChannelEnabled, splitSetupEntries |
plugin-sdk/channel-dm-policy |
createChannelDmPolicy for account-aware setup policy descriptors |
plugin-sdk/setup |
Shared setup wizard helpers, setup translator, allowlist prompts, setup status builders |
plugin-sdk/setup-runtime |
defineChannelSetupContract, createSetupTranslator, createPatchedAccountSetupAdapter, createEnvPatchedAccountSetupAdapter, createSetupInputPresenceValidator, noteChannelLookupFailure, noteChannelLookupSummary, promptResolvedAllowFrom, splitSetupEntries, createAllowlistSetupWizardProxy, createDelegatedSetupWizardProxy |
plugin-sdk/setup-tools |
formatCliCommand, detectBinary, extractArchive, resolveBrewExecutable, formatDocsLink, CONFIG_DIR |
plugin-sdk/archive |
extractArchive, readArchiveEntry, archive limits and entry kinds |
plugin-sdk/root-walk |
walkRootDirectory, root-walk options and entries |
plugin-sdk/secret-file |
createSecretFileAtomic, synchronous and asynchronous secret reads |
plugin-sdk/account-core |
Multi-account config/action-gate helpers, default-account fallback helpers |
plugin-sdk/account-id |
DEFAULT_ACCOUNT_ID, account-id normalization helpers |
plugin-sdk/account-resolution |
Account lookup + default-fallback helpers |
plugin-sdk/account-helpers |
Narrow account-list/account-action helpers |
plugin-sdk/access-groups |
Private-local after July 2026; Access-group allowlist parsing and redacted group diagnostics helpers |
plugin-sdk/channel-pairing |
createChannelPairingController |
plugin-sdk/channel-reply-pipeline |
Retained compatibility facade. channel-outbound exports createChannelMessageReplyPipeline and resolveChannelMessageSourceReplyDeliveryMode; other function names are unchanged, but named types do not all move. See retained channel mappings. |
plugin-sdk/channel-config-helpers |
createHybridChannelConfigAdapter, resolveChannelDmAccess, resolveChannelDmAllowFrom, resolveChannelDmPolicy, normalizeChannelDmPolicy, normalizeLegacyDmAliases |
plugin-sdk/channel-config-schema |
Shared channel config schema primitives plus Zod and direct JSON/TypeBox builders |
plugin-sdk/bundled-channel-config-schema |
Private-local after July 2026; Bundled OpenClaw channel config schemas for maintained bundled plugins only |
plugin-sdk/chat-channel-ids |
Private-local after July 2026; BUNDLED_CHAT_CHANNEL_IDS, BUNDLED_CHAT_CHANNEL_ENVELOPE_PREFIXES, ChatChannelId. Canonical bundled/official chat channel ids plus formatter labels/aliases for plugins that need to recognize envelope-prefixed text without hardcoding their own table. |
plugin-sdk/channel-policy |
resolveChannelGroupRequireMention |
plugin-sdk/channel-ingress-runtime |
Experimental high-level channel ingress runtime resolver, implicit-mention policy resolver, and route fact builders for migrated channel receive paths. Prefer this over assembling effective allowlists, command allowlists, and legacy projections in each plugin. See Channel ingress API. |
plugin-sdk/channel-lifecycle |
Retained compatibility facade. Selected functions move unchanged to channel-outbound; other helpers require behavioral migration or an owner-approved public replacement. Named types do not all move. See retained channel mappings. |
plugin-sdk/channel-outbound |
Message lifecycle contracts plus reply pipeline options, receipts, live preview/streaming, lifecycle helpers, outbound identity, payload planning, durable sends, and message-send context helpers. See Channel outbound API. |
plugin-sdk/channel-message |
Retained compatibility facade. Move outbound exports to channel-outbound and its three dispatch aliases to their renamed exports in channel-inbound. See retained channel mappings. |
plugin-sdk/inbound-envelope |
Shared inbound route + envelope builder helpers |
plugin-sdk/inbound-event-delivery |
Process-local correlation between active inbound events and successful channel sends |
plugin-sdk/inbound-reply-dispatch |
Deprecated compatibility shim for dispatchInboundReplyWithBase; its compatibility-ledger gate is the next Plugin SDK major, not a calendar date. Use plugin-sdk/channel-inbound for inbound runners and plugin-sdk/channel-outbound for message delivery helpers. |
plugin-sdk/outbound-media |
Private-local after July 2026; Shared outbound media loading and hosted-media state helpers |
plugin-sdk/poll-runtime |
Private-local after July 2026; Narrow poll normalization helpers |
plugin-sdk/thread-bindings-runtime |
Private-local after July 2026; Thread-binding lifecycle and adapter helpers |
plugin-sdk/agent-media-payload |
Deprecated compatibility facade for legacy Media* payload projection. Pass ordered facts through MsgContext.media / toInboundMediaFacts(...); import local-root policy from plugin-sdk/media-local-roots. |
plugin-sdk/conversation-runtime |
Deprecated broad barrel for conversation/thread binding, pairing, and configured-binding helpers; prefer focused binding subpaths such as plugin-sdk/thread-bindings-runtime and plugin-sdk/session-binding-runtime |
plugin-sdk/runtime-group-policy |
Runtime group-policy resolution helpers |
plugin-sdk/channel-status |
Shared channel status snapshot/summary helpers |
plugin-sdk/channel-config-primitives |
Narrow channel config-schema primitives |
plugin-sdk/channel-config-writes |
Private-local after July 2026; Channel config-write authorization helpers |
plugin-sdk/channel-plugin-common |
Shared channel plugin prelude exports |
plugin-sdk/allowlist-config-edit |
Allowlist config edit/read helpers |
plugin-sdk/direct-dm-guard-policy |
Private-local after July 2026; Narrow direct-DM pre-crypto guard policy helpers |
plugin-sdk/discord |
Deprecated Discord compatibility facade for published @openclaw/discord@2026.3.13 and tracked owner compatibility; new plugins should use generic channel SDK subpaths |
plugin-sdk/telegram-account |
Deprecated Telegram account-resolution compatibility facade for tracked owner compatibility; new plugins should use injected runtime helpers or generic channel SDK subpaths |
plugin-sdk/interactive-runtime |
Semantic message presentation, delivery, and legacy interactive reply helpers. See Message Presentation |
plugin-sdk/question-gateway-runtime |
Resolve runtime-authored ask_user choices through the Gateway from channel interaction handlers |
plugin-sdk/channel-inbound |
Shared inbound helpers for event classification, context building, formatting, roots, debounce, mention matching, mention-policy, and inbound logging |
plugin-sdk/channel-inbound-debounce |
Narrow inbound debounce helpers |
plugin-sdk/channel-mention-gating |
Private-local after July 2026; Narrow mention-policy, mention marker, and mention text helpers without the broader inbound runtime surface |
plugin-sdk/channel-streaming-config |
Dependency-light channel streaming config readers (getChannelStreamingConfigObject, resolveChannelStreamingNativeTransport) for doctor contract closures and other control-plane paths that must not load the reply pipeline |
plugin-sdk/channel-send-result |
Reply result types |
plugin-sdk/channel-actions |
Channel message-action helpers, plus deprecated native schema helpers kept for plugin compatibility |
plugin-sdk/channel-route |
Private-local after July 2026; Shared route normalization, parser-driven target resolution, thread-id stringification, dedupe/compact route keys, parsed-target types, and route/target comparison helpers |
plugin-sdk/channel-targets |
Private-local after July 2026; Target parsing helpers; route comparison callers should use plugin-sdk/channel-route |
plugin-sdk/channel-contract |
Channel contract types |
plugin-sdk/channel-feedback |
Feedback/reaction wiring |
plugin-sdk/reply-payload |
Reply payload types, normalization, content/media inspection, native question option ordering, chunked send helpers, reasoning detection, and reply fan-out |
The September channel facades remain public as removal-pending records until
their recorded blockers are resolved; a registry date does not automatically
remove an export. See the removal timeline.
July aliases such as direct-DM access, reply-options, pairing paths, and channel
runtime splinters have been removed; bundled-only helpers are private-local.
Provider subpaths
| Subpath | Key exports |
|---|---|
plugin-sdk/provider-entry |
Private-local after July 2026; defineSingleProviderPluginEntry |
plugin-sdk/provider-setup |
Private-local after July 2026; Curated local/self-hosted provider setup helpers |
plugin-sdk/cli-backend |
Private-local after July 2026; CLI backend defaults + watchdog constants |
plugin-sdk/provider-auth-runtime |
Private-local after July 2026; provider auth runtime helpers including startProviderOAuthLoopbackCallbackServer, token exchange, auth persistence, and API-key resolution |
plugin-sdk/provider-oauth-runtime |
Private-local after July 2026; Generic provider OAuth callback types, callback-page rendering, PKCE/state helpers, authorization-input parsing, canonical OpenAI JWT payload decoding and identity extraction, token-expiry helpers, and abort helpers |
plugin-sdk/provider-auth-api-key |
Private-local after July 2026; API-key onboarding/profile-write helpers such as upsertApiKeyProfile |
plugin-sdk/provider-auth-result |
Private-local after July 2026; Standard OAuth auth-result builder |
plugin-sdk/provider-env-vars |
Private-local after July 2026; Provider auth env-var lookup helpers |
plugin-sdk/provider-auth |
createProviderApiKeyAuthMethod, ensureApiKeyFromOptionEnvOrPrompt, upsertAuthProfile, upsertApiKeyProfile, writeOAuthCredentials, OpenAI Codex auth-import helpers, deprecated resolveOpenClawAgentDir compatibility export |
plugin-sdk/provider-model-shared |
Private-local after July 2026; ProviderReplayFamily, buildProviderReplayFamilyHooks, resolveFamilyForwardCompatModel, selectPreferredLocalModelId, normalizeModelCompat, parseModelRef, shared replay-policy builders, provider-endpoint helpers, and shared model-id normalization helpers |
plugin-sdk/provider-catalog-live-runtime |
Private-local after July 2026; Live provider model catalog helpers for guarded /models-style discovery: buildLiveModelProviderConfig, provider-owned projectRows, fetchLiveProviderModelRows, getCachedLiveProviderModelRows, fetchLiveProviderModelIds, LiveModelCatalogHttpError, clearLiveCatalogCacheForTests, TTL cache, and static fallback |
plugin-sdk/provider-catalog-runtime |
Provider catalog augmentation runtime hook and plugin-provider registry seams for contract tests |
plugin-sdk/provider-catalog-shared |
Private-local after July 2026; findCatalogTemplate, buildSingleProviderApiKeyCatalog, buildManifestModelProviderConfig, supportsNativeStreamingUsageCompat, applyProviderNativeStreamingUsageCompat |
plugin-sdk/provider-http |
Private-local after July 2026; Generic provider HTTP/endpoint capability helpers, provider HTTP errors, and audio transcription multipart form helpers |
plugin-sdk/provider-binary-stream |
Direct-reader bounded binary streams with fitting-prefix delivery and explicit overflow/release errors |
plugin-sdk/provider-web-fetch-contract |
Private-local after July 2026; Narrow web-fetch config/selection contract helpers such as enablePluginInConfig and WebFetchProviderPlugin |
plugin-sdk/provider-web-fetch |
Private-local after July 2026; Web-fetch provider registration/cache helpers |
plugin-sdk/provider-web-search-config-contract |
Private-local after July 2026; Narrow web-search config/credential helpers for providers that do not need plugin-enable wiring |
plugin-sdk/provider-web-search-contract |
Private-local after July 2026; Narrow web-search config/credential contract helpers such as createWebSearchProviderContractFields, enablePluginInConfig, resolveProviderWebSearchPluginConfig, and scoped credential setters/getters |
plugin-sdk/provider-web-search |
Private-local after July 2026; Web-search provider registration/cache/runtime helpers |
plugin-sdk/embedding-providers |
Private-local after July 2026; General embedding provider types and read helpers, including EmbeddingProviderAdapter, getEmbeddingProvider(...), and listEmbeddingProviders(...); plugins register providers through api.registerEmbeddingProvider(...) so manifest ownership is enforced |
plugin-sdk/provider-tools |
Private-local after July 2026; ProviderToolCompatFamily, buildProviderToolCompatFamilyHooks, and DeepSeek/Gemini/OpenAI schema cleanup + diagnostics |
plugin-sdk/provider-usage |
Private-local after July 2026; Provider usage snapshot types, shared usage fetch helpers, and provider fetchers such as fetchClaudeUsage |
plugin-sdk/provider-stream |
Private-local after July 2026; ProviderStreamFamily, buildProviderStreamFamilyHooks, composeProviderStreamWrappers, stream wrapper types, plain-text tool-call compat, and shared Anthropic/Google/Kilocode/MiniMax/Moonshot/OpenAI/OpenRouter/Z.AI wrapper helpers |
plugin-sdk/provider-stream-shared |
Private-local after July 2026; Public shared provider stream wrapper helpers including composeProviderStreamWrappers, createOpenAICompatibleCompletionsThinkingOffWrapper, createPlainTextToolCallCompatWrapper, createPayloadPatchStreamWrapper, createToolStreamWrapper, normalizeOpenAICompatibleReasoningPayload, setQwenChatTemplateThinking, and Anthropic/DeepSeek/OpenAI-compatible stream utilities |
plugin-sdk/provider-transport-runtime |
Private-local after July 2026; Native provider transport helpers such as guarded fetch, tool-result text extraction, transport message transforms, and writable transport event streams |
plugin-sdk/provider-onboard |
Private-local after July 2026; Onboarding config patch helpers |
plugin-sdk/global-singleton |
Private-local after July 2026; Process-local singleton/map/cache helpers |
plugin-sdk/group-activation |
Private-local after July 2026; Narrow group activation mode and command parsing helpers |
createBoundedProviderBinaryStream requires a request cleanup callback.
Stream cancellation and release() start source cancellation, unlock the reader,
and run cleanup once, then wait for both operations. Cancellation propagates
source failures; release() ignores them. Cleanup failures take precedence in
both cases. Overflow preserves its fitting prefix and error without waiting for
cleanup; later release() reports cleanup failure. After EOF or a read error,
the caller must still invoke and await release().
Provider usage snapshots normally report one or more quota windows, each with
a label, percent used, and optional reset time. Providers that expose balance or
account-state text instead of resettable quota windows should return
summary with an empty windows array rather than fabricating percentages.
OpenClaw displays that summary text in status output; use error only when the
usage endpoint failed or returned no usable usage data.
Auth and security subpaths
| Subpath | Key exports |
|---|---|
plugin-sdk/command-auth |
Deprecated broad command authorization surface (resolveControlCommandGate, command registry helpers including dynamic argument menu formatting, sender-authorization helpers); use channel ingress/runtime authorization or command-status helpers |
plugin-sdk/command-status |
Command/help message builders such as buildCommandsMessagePaginated and buildHelpMessage |
plugin-sdk/approval-auth-runtime |
Approver resolution and same-chat action-auth helpers |
plugin-sdk/approval-client-runtime |
Native exec approval profile/filter helpers |
plugin-sdk/approval-delivery-runtime |
Native approval capability/delivery adapters |
plugin-sdk/approval-gateway-runtime |
Shared approval gateway resolver |
plugin-sdk/approval-reference-runtime |
Private-local after July 2026; Deterministic durable-locator helper for transport-limited approval callbacks |
plugin-sdk/approval-handler-adapter-runtime |
Lightweight native approval adapter loading helpers for hot channel entrypoints |
plugin-sdk/approval-handler-runtime |
Broader approval handler runtime helpers; prefer the narrower adapter/gateway seams when they are enough |
plugin-sdk/approval-native-runtime |
Native approval target, account-binding, route-gate, forwarding fallback, and local native exec prompt suppression helpers |
plugin-sdk/approval-reaction-runtime |
Private-local after July 2026; Hardcoded approval reaction bindings, reaction prompt payloads, reaction target stores, reaction hint text helpers, and compatibility export for local native exec prompt suppression |
plugin-sdk/approval-reply-runtime |
Exec/plugin approval reply payload helpers |
plugin-sdk/approval-runtime |
Exec/plugin/system-agent approval payload helpers, approval-capability builders, approval auth/profile helpers, native approval routing/runtime helpers, and structured approval display helpers such as formatApprovalDisplayPath |
plugin-sdk/command-auth-native |
Native command auth, dynamic argument menu formatting, and native session-target helpers |
plugin-sdk/command-detection |
Shared command detection helpers |
plugin-sdk/command-primitives-runtime |
Lightweight command text predicates for hot channel paths |
plugin-sdk/command-surface |
Private-local after July 2026; Command-body normalization and command-surface helpers |
plugin-sdk/allow-from |
Allow-from parsing, normalization, resolution, and matching helpers |
plugin-sdk/provider-auth-login-flow-runtime |
Private-local after July 2026; Lazy provider auth login flow helpers for private channel and Web UI device-code pairing |
plugin-sdk/channel-secret-basic-runtime |
Narrow secret-contract exports and target-registry builders for non-TTS channel/plugin secret surfaces |
plugin-sdk/channel-secret-tts-runtime |
Private-local after July 2026; Narrow nested channel TTS secret assignment helpers |
plugin-sdk/secret-ref-runtime |
Narrow SecretRef typing, resolution, setup-plan construction, and setup CLI scaffolding for plugin-owned secret providers |
plugin-sdk/security-runtime |
Deprecated broad barrel for trust, DM gating, root-bounded file/path helpers including create-only writes, sync/async atomic file replacement, sibling temp writes, cross-device move fallback, private file-store helpers, symlink-parent guards, external-content, sensitive text redaction, constant-time secret comparison, and secret-collection helpers; prefer focused security/SSRF/secret subpaths |
plugin-sdk/ssrf-policy |
Host allowlist and private-network SSRF policy helpers |
plugin-sdk/ssrf-dispatcher |
Private-local after July 2026; Narrow pinned-dispatcher helpers without the broad infra runtime surface |
plugin-sdk/ssrf-runtime |
Pinned-dispatcher, SSRF-guarded fetch, SsrFBlockedError and GuardedFetchRedirectError, SSRF policy helpers, and loopback/private host classification |
plugin-sdk/secret-input |
Secret input parsing helpers and isBuiltInDefaultSecretProviderRef(config, ref), which returns true when the built-in env or store provider owns its source's selected default alias, and false for a same-source explicit provider entry |
plugin-sdk/secret-input-runtime |
Secret input normalization, SecretRef coercion, configured secret resolution, and manifest-owned capability availability guards |
plugin-sdk/secret-ref-readonly |
Closed available/missing/blocked resolution and provider-policy checks for read-only env SecretRefs |
plugin-sdk/webhook-ingress |
Webhook request/target helpers and raw websocket/body coercion |
plugin-sdk/webhook-request-guards |
Request body size/timeout helpers, canonical Gateway browser-origin acceptance via resolveAcceptedBrowserOrigin, and runDetachedWebhookWork for tracked post-ack processing |
For structured SecretRefs, resolveReadOnlyEnvSecretRef returns blocked when the ref cannot be used, including an allowed env ref whose value is missing or empty. Callers may apply their existing fallback only for missing; a blocked ref must not borrow ambient or auth-profile credentials. Its provider check follows source-specific default aliases and explicit env allowlists.
Use isLoopbackHost(host) when a plugin must accept only the local machine. It accepts localhost, IPv4 loopback literals across 127.0.0.0/8, ::1, bracketed IPv6, and IPv4-mapped IPv6 loopback literals. It parses IP literals rather than matching text prefixes, so a DNS name such as 127.0.0.1.evil.com is not loopback. Use isPrivateOrLoopbackHost(host) only when private-network hosts such as RFC 1918 addresses are also valid.
Runtime and storage subpaths
| Subpath | Key exports |
|---|---|
plugin-sdk/runtime |
Runtime/logging/backup helpers, plugin install-path warnings, and process helpers |
plugin-sdk/runtime-env |
Narrow runtime env, logger, timeout, retry, and backoff helpers |
plugin-sdk/browser-cdp |
Private host runtime; parseBrowserHttpUrl and redactCdpUrl for Browser URL handling. JavaScript-only package export, not a typed third-party SDK contract. |
plugin-sdk/browser-config |
Private-local after July 2026; Supported browser config facade for normalized profile/defaults, CDP URL parsing, and browser-control auth helpers |
plugin-sdk/agent-harness-task-runtime |
Private-local after July 2026; Generic task lifecycle and completion delivery helpers for harness-backed agents using a host-issued task scope |
plugin-sdk/agent-harness-runtime |
Agent-harness runtime helpers, including the bounded agentHarnessStructuredInput form/URL compilation and execution surface. acquireSessionWriteLock, resolveSessionWriteLockAcquireTimeoutMs, resolveSessionWriteLockOptions, and SessionWriteLockAcquireTimeoutConfig are deprecated no-op compatibility exports scheduled for removal in the 2026.10 release train. They no longer block or create lock sidecars; harnesses should rely on OpenClaw's per-session lane plus the durable writer claim and in-transaction fence. |
plugin-sdk/codex-mcp-projection |
Private-local after July 2026; Bundled Codex helper for projecting user MCP server config into Codex thread config; not for third-party plugins |
plugin-sdk/native-hook-relay-runtime |
Private-local bundled runtime helper for retained native direct-child hook policy; not for third-party plugins |
plugin-sdk/codex-session-transcript-runtime |
Private-local bundled Codex helper for serializing transcript-mirror writes; not for third-party plugins |
plugin-sdk/channel-runtime-context |
Generic channel runtime-context registration and lookup helpers |
plugin-sdk/runtime-store |
createPluginRuntimeStore |
plugin-sdk/plugin-command-runtime |
Registry-generation-bound native plugin command candidates, terminal catalog decisions, and exact selected dispatch execution |
plugin-sdk/plugin-runtime |
Deprecated broad barrel for plugin command/hook/http/interactive helpers; prefer focused plugin runtime subpaths |
plugin-sdk/hook-runtime |
Deprecated broad barrel for webhook/internal hook pipeline helpers; prefer focused hook/plugin runtime subpaths |
plugin-sdk/lazy-runtime |
Lazy runtime import/binding helpers such as createLazyRuntimeModule, createLazyRuntimeMethod, and createLazyRuntimeSurface |
plugin-sdk/process-runtime |
Private-local after July 2026; bounded process execution with per-stream and aggregate output caps, opt-in stream-error termination, configurable TERM-to-KILL grace, and prepareSecretInputStdio for one-shot credential descriptors |
plugin-sdk/node-host |
Private-local after July 2026; Node-host executable resolution and PTY resume helpers |
plugin-sdk/node-selection-runtime |
Private-local bundled runtime facade for shared capability-gated node selection policy |
plugin-sdk/cli-argv |
Dependency-light root-option parsing for CLI metadata, including getRootOptionAwareCommandPath and consumeRootOptionToken |
plugin-sdk/cli-runtime |
Private-local after July 2026; Deprecated broad barrel for CLI formatting, wait, version, argument-invocation, and lazy command-group helpers; prefer focused CLI/runtime subpaths |
plugin-sdk/node-cli-runtime |
Shared node CLI Gateway options, invoke envelope, terminal presentation, and authorization-hint error handling for plugin-owned node commands |
plugin-sdk/qa-runner-runtime |
Private-local after July 2026; Supported facade exposing plugin QA scenarios through the CLI command surface |
plugin-sdk/tts-runtime |
Private-local after July 2026; Supported facade for text-to-speech config schemas and runtime helpers |
plugin-sdk/gateway-config-runtime |
Private-local bundled runtime facade for dependency-light Gateway port resolution (resolveGatewayPort); not for third-party plugins |
plugin-sdk/gateway-method-runtime |
Reserved Gateway method dispatch helper for plugin HTTP routes that declare contracts.gatewayMethodDispatch: ["authenticated-request"] |
plugin-sdk/gateway-runtime |
Gateway client, event-loop-ready client start helper, gateway CLI RPC, gateway protocol errors, advertised LAN host resolution, and channel-status patch helpers |
plugin-sdk/config-contracts |
Focused config surface for plugin config shapes such as OpenClawConfig and channel/provider config types, plus the dependency-light runtime helper resolveGatewayPublicOrigin(cfg) which returns the normalized gateway.publicOrigin (bare http(s) origin, optional reverse-proxy path, no query/hash) or undefined when unset, for building links back to the Gateway |
plugin-sdk/config-runtime |
Retained broad config compatibility facade; prefer passed config, api.pluginConfig, config-contracts, config-mutation, and runtime-config-snapshot where they cover the needed contract. Named types and private-runtime helpers are not blanket replacements; see migration guidance. |
plugin-sdk/plugin-config-runtime |
Deprecated compatibility facade for runtime plugin-config helpers; new plugins use api.pluginConfig plus focused config contracts, snapshots, and mutation helpers |
plugin-sdk/config-mutation |
Transactional config mutation helpers such as mutateConfigFile, replaceConfigFile, and logConfigUpdated |
plugin-sdk/message-tool-delivery-hints |
Private-local after July 2026; Shared message-tool delivery metadata hint strings |
plugin-sdk/runtime-config-snapshot |
Current process config snapshot helpers such as getRuntimeConfig, getRuntimeConfigSnapshot, and test snapshot setters |
plugin-sdk/text-autolink-runtime |
Private-local after July 2026; File-reference autolink detection without the broad text barrel |
plugin-sdk/reply-runtime |
Shared inbound/reply runtime helpers, chunking, dispatch, heartbeat, reply planner |
plugin-sdk/reply-dispatch-runtime |
Narrow reply dispatch/finalize and conversation-label helpers |
plugin-sdk/reply-history |
Shared short-window reply-history helpers. New message-turn code should use createChannelHistoryWindow; lower-level map helpers remain deprecated compatibility exports only |
plugin-sdk/reply-reference |
Private-local after July 2026; createReplyReferencePlanner |
plugin-sdk/reply-chunking |
Narrow text/markdown chunking helpers, including chunkByParagraph with splitLongParagraphs: false for transport-specific final sizing |
plugin-sdk/agent-scope-runtime |
Focused agent ID, directory, default-agent, and session-agent scope resolution helpers for dependency-light control-plane and migration paths. New plugins use resolveSessionAgentIdsStrict or resolveSessionAgentIdStrict with an explicit or prepared owner. The legacy resolver names preserve ambient system-agent fallback through November 29, 2026; see Plugin compatibility. |
plugin-sdk/session-store-runtime |
Session workflow helpers (getSessionEntry, listSessionEntries, patchSessionEntry, upsertSessionEntry), repair/lifecycle helpers (deleteSessionEntry, cleanupSessionLifecycleArtifacts, resolveSessionStoreBackupPaths), marker helpers for transitional sessionFile values, bounded recent user/assistant transcript text reads by session identity, session store path/session-key helpers, and updated-at reads, without broad config writes/maintenance imports |
plugin-sdk/session-catalog |
External session catalog contracts, canonical cursor/parameter/transcript paging, explicit local-plus-node family composition, node-host bindings, adoption helpers, and history import |
plugin-sdk/session-discussion |
External session discussion provider contracts, registration, and canonical Control UI session path building |
plugin-sdk/session-transcript-runtime |
Private-local after July 2026; Transcript identity, bounded raw and visible cursors, scoped target/read/write helpers, visible message-entry projection, update publishing, write locks, and transcript memory hit keys |
plugin-sdk/sqlite-runtime |
Private-local after July 2026; SQLite agent-schema, path, transaction, and shared-handle borrowing helpers for first-party runtime. Type-only Generated and Selectable model generated columns and selected rows in Kysely table definitions. compileSqliteQueryBindings compiles fixed Kysely SQL with fresh bindings for caller-owned native statements; statement lifetime stays with the caller. iterateSqliteQuerySync streams Kysely query rows for incremental decoding; consume the iterator before closing its database. sqliteStringSet binds string membership as one SQLite JSON table-valued query parameter, preserving one query snapshot without a variable-count placeholder list. borrowOpenClawAgentDatabase returns { db, release }; active borrows prevent cache eviction, release() does not close the handle, and explicit owner disposal still revokes it. |
plugin-sdk/cron-store-runtime |
Private-local after July 2026; Cron store path/load/save helpers |
plugin-sdk/state-paths |
State/OAuth dir path helpers |
plugin-sdk/plugin-state-runtime |
Private-local after July 2026; Plugin-scoped keyed-state and BLOB contracts plus connection pragma, verified WAL maintenance, and atomic STRICT-schema migration helpers. Plugin-state leases were removed; use SQLite transactions and keyed stores instead |
plugin-sdk/routing |
Route/session-key/account binding helpers such as resolveAgentRoute, buildAgentSessionKey, and resolveDefaultAgentBoundAccountId. Use normalizeAgentId when omitted input should resolve to main; use the Result-returning normalizeAgentIdStrict for an explicitly supplied ID that must not fall back to the default agent. |
plugin-sdk/status-helpers |
Shared channel/account status summary helpers, runtime-state defaults, and issue metadata helpers |
plugin-sdk/target-resolver-runtime |
Private-local after July 2026; Shared target resolver helpers |
plugin-sdk/string-normalization-runtime |
Private-local after July 2026; Slug/string normalization helpers |
plugin-sdk/request-url |
Private-local after July 2026; Extract string URLs from fetch/request-like inputs |
plugin-sdk/run-command |
Timed command runner with normalized stdout/stderr results |
plugin-sdk/param-readers |
Common tool/CLI param readers |
plugin-sdk/tool-plugin |
Define a simple typed agent-tool plugin and expose static metadata for manifest generation |
plugin-sdk/tool-payload |
Private-local after July 2026; Extract normalized payloads from tool result objects |
plugin-sdk/tool-results |
Typed text and JSON agent tool result builders |
plugin-sdk/tool-send |
Extract canonical send target fields from tool args |
plugin-sdk/sandbox |
Private-local after July 2026; Sandbox backend types and SSH/OpenShell command helpers, including fail-fast exec command preflight and resolveReadOnlyWorkspaceSkillMounts for canonical read-only skill overlays in writable workspaces |
plugin-sdk/temp-path |
Shared temp-download path helpers and private secure temp workspaces |
plugin-sdk/logging-core |
Subsystem logger and redaction helpers |
plugin-sdk/markdown-table-runtime |
Private-local after July 2026; Markdown table mode and conversion helpers |
plugin-sdk/model-session-runtime |
Model/session override helpers such as applyModelOverrideToSessionEntry and resolveAgentMaxConcurrent |
plugin-sdk/talk-config-runtime |
Private-local after July 2026; Talk provider config resolution helpers |
plugin-sdk/json-store |
Small JSON state read/write helpers |
plugin-sdk/json-unsafe-integers |
Private-local after July 2026; JSON parsing helpers that preserve unsafe integer literals as strings |
plugin-sdk/file-lock |
Private-local after July 2026; Owner-scoped re-entrant file-lock helpers plus Doctor-safe reclaim of definitely stale, unchanged retired lock sidecars. Nested acquisitions share a refcount only when callers pass the same logical-operation reentrantOwner; ownerless or different-owner calls contend normally |
plugin-sdk/persistent-dedupe |
Disk-backed dedupe cache helpers |
plugin-sdk/ingress-effect-once |
Durable claim/commit guard for non-idempotent ingress side effects |
plugin-sdk/acp-runtime |
Private-local after July 2026; ACP runtime/session and reply-dispatch helpers |
plugin-sdk/acp-runtime-backend |
Private-local after July 2026; Lightweight ACP backend registration and reply-dispatch helpers for startup-loaded plugins |
plugin-sdk/acp-binding-resolve-runtime |
Private-local after July 2026; Read-only ACP binding resolution without lifecycle startup imports |
plugin-sdk/boolean-param |
Loose boolean param reader |
plugin-sdk/dangerous-name-runtime |
Private-local after July 2026; Dangerous-name matching resolution helpers |
plugin-sdk/device-bootstrap |
Device bootstrap and pairing token helpers, including BOOTSTRAP_HANDOFF_OPERATOR_SCOPES |
plugin-sdk/extension-shared |
Shared passive-channel, status, and ambient proxy helper primitives |
plugin-sdk/models-provider-runtime |
/models command/provider reply helpers |
plugin-sdk/skill-commands-runtime |
Skill command listing helpers |
plugin-sdk/native-command-registry |
Native command registry/build/serialize helpers |
plugin-sdk/agent-harness |
Experimental trusted-plugin surface for low-level agent harnesses: harness types, active-run steer/abort helpers, OpenClaw tool bridge helpers, runtime-plan tool policy helpers, terminal outcome classification, tool progress formatting/detail helpers, and attempt result utilities |
plugin-sdk/async-lock-runtime |
Private-local after July 2026; Process-local async lock helper for small runtime state files |
plugin-sdk/channel-activity-runtime |
Private-local after July 2026; Channel activity telemetry helper |
plugin-sdk/concurrency-runtime |
Private-local after July 2026; Bounded async task concurrency helper |
plugin-sdk/dedupe-runtime |
In-memory and persistent-backed dedupe cache helpers |
plugin-sdk/delivery-queue-runtime |
Private-local after July 2026; Outbound pending-delivery drain helper |
plugin-sdk/file-access-runtime |
Private-local after July 2026; Safe local-file, path-containment, temp-root, media-source path, and directory-durability helpers |
plugin-sdk/heartbeat-runtime |
Private-local after July 2026; Heartbeat wake, event, and visibility helpers |
plugin-sdk/expect-runtime |
Private-local after July 2026; Required-value assertion helper for provable runtime invariants |
plugin-sdk/number-runtime |
Private-local after July 2026; Numeric coercion helper |
plugin-sdk/secure-random-runtime |
Private-local after July 2026; Secure token/UUID helpers |
plugin-sdk/system-event-runtime |
Private-local after July 2026; Narrow system event enqueue/peek helpers |
plugin-sdk/transport-ready-runtime |
Private-local after July 2026; Transport readiness wait helper |
plugin-sdk/exec-approvals-runtime |
Private-local after July 2026; Exec approval policy file helpers without the broad infra-runtime barrel |
plugin-sdk/infra-runtime |
Deprecated compatibility shim; use injected runtime APIs or documented typed-public subpaths |
plugin-sdk/collection-runtime |
Small bounded cache helpers |
plugin-sdk/diagnostic-flags |
isDiagnosticFlagEnabled for flag-only consumers without event, trace, or redaction initialization |
plugin-sdk/diagnostic-runtime |
Diagnostic flag, event, trace-context, and low-cardinality dimension normalization helpers |
plugin-sdk/error-runtime |
Error graph, formatting, unknown-value coercion, shared error classification helpers, PlatformMessageNotDispatchedError, isApprovalNotFoundError |
plugin-sdk/fetch-runtime |
Private-local after July 2026; Wrapped fetch, proxy, EnvHttpProxyAgent option, and pinned lookup helpers |
plugin-sdk/proxy-capture |
Debug proxy capture configuration, SQLite-backed capture storage and read-only access, HTTP/WebSocket capture events, and capture lifecycle helpers |
plugin-sdk/runtime-fetch |
Private-local after July 2026; Dispatcher-aware runtime fetch without proxy/guarded-fetch imports |
plugin-sdk/blob-runtime |
Private official-plugin runtime; Exact Buffer views for synchronous Blob construction |
plugin-sdk/inline-image-data-url-runtime |
Private-local after July 2026; Inline image data URL sanitizer and signature sniffing helpers without the broad media runtime surface |
plugin-sdk/response-limit-runtime |
Private-local after July 2026; Byte-, idle-, and deadline-bounded response-body readers without the broad media runtime surface |
plugin-sdk/session-binding-runtime |
Private-local after July 2026; Current conversation binding state without configured binding routing or pairing stores |
plugin-sdk/context-visibility-runtime |
Private-local after July 2026; Context visibility resolution and supplemental context filtering without broad config/security imports |
plugin-sdk/string-coerce-runtime |
Browser-safe primitive coercion, string normalization, Date-valid timestamps, and UTF-16 truncation |
plugin-sdk/html-entity-runtime |
Private-local after July 2026; Single-pass semicolon-terminated HTML5 entity decoding without broad text utilities |
plugin-sdk/text-utility-runtime |
Private-local after July 2026; Low-level text and path helpers, including UTF-8 prefix truncation and five-entity HTML escaping |
plugin-sdk/widget-html |
Complete-document detection, size validation, and tool input errors for self-contained HTML widgets |
plugin-sdk/host-runtime |
Private-local after July 2026; Hostname and SCP host normalization helpers |
plugin-sdk/retry-runtime |
Private-local after July 2026; Retry config and retry runner helpers |
plugin-sdk/agent-runtime |
Deprecated broad barrel for agent dir/identity/workspace helpers, including resolveAgentDir, resolveDefaultAgentDir, and the deprecated resolveOpenClawAgentDir compatibility export; prefer focused agent/runtime subpaths |
plugin-sdk/directory-runtime |
Config-backed directory query/dedup |
plugin-sdk/keyed-async-queue |
Private-local after July 2026; KeyedAsyncQueue |
Private process callers declare using prepared = prepareSecretInputStdio(stdio, secretInput)
before spawning, then call await prepared?.deliverTo(child) once. Delivery closes the writer
and zeroes the transient credential buffer; disposal closes any untransferred descriptors,
including when spawning throws. POSIX uses anonymous pipes that support descriptor-path readers
without credential files; Windows retains its overlapped child pipe. Callers own child cleanup
when delivery fails.
Capability and testing subpaths
| Subpath | Key exports |
|---|---|
plugin-sdk/media-runtime |
Deprecated broad media barrel including saveRemoteMedia, saveResponseMedia, readRemoteMediaBuffer, and deprecated fetchRemoteMedia; prefer plugin-sdk/media-store, plugin-sdk/media-mime, plugin-sdk/outbound-media, and capability runtime subpaths, and prefer store helpers before buffer reads when a URL should become OpenClaw media |
plugin-sdk/media-local-roots |
Focused getAgentScopedMediaLocalRoots(...) and policy-aware getAgentScopedMediaLocalRootsForSources(...) helpers for plugin-owned local media reads |
plugin-sdk/media-mime |
Narrow MIME normalization, file-extension mapping, MIME detection, and media-kind helpers |
plugin-sdk/media-store |
Narrow media store helpers such as saveMediaBuffer, saveMediaStream, and saveMediaSource (local path or HTTP(S) URL into managed media with core's SSRF, byte, redirect, and timeout limits) |
plugin-sdk/media-generation-runtime |
Private-local after July 2026; Shared media-generation failover helpers, candidate selection, and missing-model messaging |
plugin-sdk/media-understanding |
Deprecated compatibility facade for media-understanding provider types and helpers; new providers register through the injected plugin API and keep request helpers plugin-owned |
plugin-sdk/media-understanding-runtime |
Channel audio preflight/echo helpers plus image, video, audio, and structured media-understanding runtime functions |
plugin-sdk/computer-use |
Computer Use v2 action and snapshot schemas, JSON parsers, validation, capability descriptors, and provider registration |
plugin-sdk/native-command-config-runtime |
Dependency-light native command and skill enablement config checks |
plugin-sdk/text-chunking |
Outbound text and offset-preserving range chunking, opt-in inline code source maps and renderer syntax through findCodeRegions(text, { includeSource: true, syntax: "commonmark" }) (GFM by default), the UTF-16 boundary helper avoidTrailingHighSurrogateBreak, markdown chunking/render helpers, quote-aware HTML tag tokenization, markdown table conversion, directive-tag stripping, and safe-text utilities |
plugin-sdk/speech |
Private-local after July 2026; Speech provider types plus provider-facing directive, registry, validation, OpenAI-compatible TTS builder, and speech helper exports |
plugin-sdk/speech-core |
Private-local after July 2026; Shared speech provider types, registry, directive, normalization, and speech helper exports |
plugin-sdk/speech-provider |
Private-local JavaScript-only host runtime for official plugins; speech provider types, configuration and directive helpers, and the OpenAI-compatible provider factory without host registry or synthesis imports. |
plugin-sdk/speech-settings |
Lightweight TTS config resolution and normalization primitives without provider registries or synthesis runtime |
plugin-sdk/realtime-transcription |
Private-local after July 2026; Realtime transcription provider types, registry helpers, and shared WebSocket session helper |
plugin-sdk/realtime-transcription-session |
Private-local JavaScript-only host runtime for official plugins; shared WebSocket session construction and types without loading the host provider registry. Use this for provider implementation imports. |
plugin-sdk/realtime-bootstrap-context |
Private-local after July 2026; Realtime profile bootstrap helper for bounded IDENTITY.md, USER.md, and SOUL.md context injection |
plugin-sdk/realtime-voice-audio-queue |
Private-local JavaScript-only host runtime for bundled or separately published official plugins; narrow bounded audio queue seam for lazy realtime voice provider facades without importing the broader realtime voice runtime; not for third-party plugins |
plugin-sdk/realtime-voice-provider |
Private-local JavaScript-only host runtime for official plugins; provider types, audio formats/codecs, response outcomes, and connection lifecycle primitives without host provider registries or agent-consult execution. |
plugin-sdk/realtime-voice-activation |
Private-local; dependency-light realtime-voice activation-name helpers (normalize, match, word-count, sort) for doctor contract closures and other control-plane paths that must not load the realtime voice runtime |
plugin-sdk/realtime-voice |
Private-local after July 2026; Realtime voice provider types, registry helpers, shared audio-energy/speech-onset gates, and realtime voice behavior helpers, including the transport-independent session harness and output activity tracking. For official runtime consumers, sender-auth contract revision 1 forwards ingress-authenticated senderId and senderIsOwner unchanged; ingress owns authentication, and consumers requiring the handoff must fail closed on other revisions. |
plugin-sdk/meeting-page-script-runtime |
Private-local JavaScript-only host runtime for official browser-meeting plugins; shared transcript and leave page-script source builders; not a third-party plugin API |
plugin-sdk/meeting-runtime |
Browser-meeting session runtime, realtime audio engines/transports, MeetingPlatformAdapter, browser/node control, agent-consult, voice-call delegation, setup checks, and SoX command helpers |
plugin-sdk/image-generation |
Private-local after July 2026; Image generation provider types plus image asset/data URL helpers and the OpenAI-compatible image provider builder |
plugin-sdk/image-generation-core |
Private-local after July 2026; Shared image-generation types, failover, auth, and registry helpers |
plugin-sdk/music-generation |
Private-local after July 2026; Music generation provider/request/result types |
plugin-sdk/video-generation |
Private-local after July 2026; Video generation provider/request/result types |
plugin-sdk/transcripts |
Private-local after July 2026; Shared transcript source provider types, registry helpers, meeting-provider bridge factory, session descriptors, and utterance metadata |
plugin-sdk/webhook-targets |
Private-local after July 2026; Webhook target registry and route-install helpers |
plugin-sdk/web-media |
Shared remote/local media loading helpers |
plugin-sdk/plugin-test-api |
Repo-local minimal createTestPluginApi helper for direct plugin registration unit tests without importing repo test helper bridges |
plugin-sdk/agent-runtime-test-contracts |
Repo-local native agent-runtime adapter contract fixtures for auth, delivery, fallback, tool-hook, prompt-overlay, schema, and transcript projection tests |
plugin-sdk/channel-test-helpers |
Repo-local channel-oriented test helpers for generic actions/setup/status contracts, directory assertions, account startup lifecycle, send-config threading, runtime mocks, status issues, outbound delivery, and hook registration |
plugin-sdk/channel-target-testing |
Repo-local shared target-resolution error-case suite for channel tests |
plugin-sdk/channel-contract-testing |
Repo-local narrow channel contract test helpers without the broad testing barrel |
plugin-sdk/plugin-test-contracts |
Repo-local plugin package, registration, public artifact, runtime API, and import side-effect contract helpers |
plugin-sdk/plugin-state-test-runtime |
Repo-local plugin state store, ingress queue, and state DB test helpers |
plugin-sdk/provider-test-contracts |
Repo-local provider runtime, auth, discovery, onboard, catalog, wizard, media capability, replay policy, realtime STT live-audio, web-search/fetch, and stream contract helpers |
plugin-sdk/provider-http-test-mocks |
Private-local after July 2026; Repo-local opt-in Vitest HTTP/auth mocks for provider tests that exercise plugin-sdk/provider-http |
plugin-sdk/reply-payload-testing |
Repo-local helpers for attaching metadata to reply payload fixtures |
plugin-sdk/sqlite-runtime-testing |
Repo-local SQLite lifecycle helpers for first-party tests |
plugin-sdk/test-state |
Repo-local isolated OpenClaw state, config, workspace, environment, and auth-profile fixtures for plugin tests |
plugin-sdk/test-fixtures |
Repo-local generic CLI runtime capture, direct-import smoke, sandbox context, skill writer, agent-message, system-event, module reload, bundled plugin path, terminal-text, chunking, auth-token, and typed-case fixtures |
plugin-sdk/test-node-mocks |
Repo-local focused Node builtin mock helpers for use inside Vitest vi.mock("node:*") factories |
Memory subpaths
| Subpath | Key exports |
|---|---|
plugin-sdk/memory-core-host-embedding-registry |
Private-local after July 2026; Lightweight memory embedding provider registry helpers |
plugin-sdk/memory-core-host-engine-curated |
Private-local focused curated-memory annotation parsing for doctor and promotion paths |
plugin-sdk/memory-core-host-engine-foundation |
Memory host foundation engine exports |
plugin-sdk/memory-core-host-engine-fs |
Private-local focused filesystem and user-path helpers for doctor migrations |
plugin-sdk/memory-core-host-engine-embeddings |
Private-local after July 2026; Memory host embedding contracts and batch/remote helpers. Providers register through the generic embedding provider API. |
plugin-sdk/memory-core-host-engine-sessions |
Private-local after July 2026; Memory session transcript and query helpers |
plugin-sdk/memory-core-host-engine-schema |
Private-local focused memory index schema and sqlite-vec helpers for doctor migrations |
plugin-sdk/memory-core-host-engine-storage |
Private-local after July 2026; Memory host storage engine exports |
plugin-sdk/memory-core-host-secret |
Private-local after July 2026; Memory host secret helpers |
plugin-sdk/memory-core-host-status |
Private-local after July 2026; Memory host status helpers |
plugin-sdk/memory-core-host-runtime-cli |
Private-local after July 2026; Memory host CLI runtime helpers |
plugin-sdk/memory-core-host-runtime-core |
Private-local after July 2026; Memory host core runtime helpers |
plugin-sdk/memory-core-host-runtime-files |
Private-local after July 2026; Memory host file/runtime helpers |
plugin-sdk/memory-host-core |
Deprecated compatibility facade for vendor-neutral memory host helpers. New memory plugins use injected memory capabilities and host-prepared prompts; companion plugins still use the retained facade for public-artifact discovery until a focused read seam exists. |
plugin-sdk/memory-host-events |
Private-local after July 2026; Vendor-neutral alias for memory host event journal helpers |
plugin-sdk/memory-host-markdown |
Private-local after July 2026; Shared managed-markdown helpers for memory-adjacent plugins |
plugin-sdk/memory-host-search |
Private-local after July 2026; Active memory runtime facade for search-manager access |
Reserved bundled-helper subpaths
Reserved bundled-helper SDK subpaths are narrow owner-specific surfaces for
bundled plugin code. They are tracked in the SDK inventory so package
builds and aliasing stay deterministic, but they are not general plugin
authoring APIs. New reusable host contracts should use generic SDK subpaths
such as plugin-sdk/gateway-runtime and plugin-sdk/ssrf-runtime.
| Subpath | Owner and purpose |
|---|---|
plugin-sdk/codex-mcp-projection |
Private-local after July 2026; Bundled Codex plugin helper for projecting user MCP server config into Codex app-server thread config (default-only package export) |
plugin-sdk/codex-session-transcript-runtime |
Private-local bundled Codex plugin helper for serializing transcript-mirror writes (default-only package export) |
plugin-sdk/ssrf-runtime-internal |
Private-local host helper for configured loopback requests owned by bundled Ollama/browser and the exact official @openclaw/llama-cpp-provider package (default-only package export) |
Related
Was this useful?
