OpenClaw mudou de uma ampla camada de compatibilidade retroativa para uma arquitetura moderna de plugins com importações focadas e documentadas. Se seu plugin foi criado antes da nova arquitetura, este guia ajuda você a migrar.Documentation Index
Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt
Use this file to discover all available pages before exploring further.
O que está mudando
O sistema antigo de plugins fornecia duas superfícies totalmente abertas que permitiam aos plugins importar qualquer coisa de que precisassem a partir de um único ponto de entrada:openclaw/plugin-sdk/compat- uma única importação que reexportava dezenas de auxiliares. Ela foi introduzida para manter plugins mais antigos baseados em hooks funcionando enquanto a nova arquitetura de plugins estava sendo criada.openclaw/plugin-sdk/infra-runtime- um amplo barrel de auxiliares de runtime que misturava eventos do sistema, estado de heartbeat, filas de entrega, auxiliares de fetch/proxy, auxiliares de arquivos, tipos de aprovação e utilitários não relacionados.openclaw/plugin-sdk/config-runtime- um amplo barrel de compatibilidade de configuração que ainda carrega auxiliares diretos obsoletos de carregamento/gravação durante a janela de migração.openclaw/extension-api- uma ponte que dava aos plugins acesso direto a auxiliares do lado do host, como o executor de agente incorporado.api.registerEmbeddedExtensionFactory(...)- um hook removido de extensão empacotada exclusivo do Pi que podia observar eventos do executor incorporado, comotool_result.
Por que isso mudou
A abordagem antiga causava problemas:- Inicialização lenta - importar um auxiliar carregava dezenas de módulos não relacionados
- Dependências circulares - reexportações amplas facilitavam a criação de ciclos de importação
- Superfície de API pouco clara - não havia como saber quais exports eram estáveis ou internos
openclaw/plugin-sdk/\<subpath\>)
é um módulo pequeno, autocontido, com um propósito claro e contrato documentado.
Seams legados de conveniência de provedor para canais empacotados também foram removidos.
Seams auxiliares com marca de canal eram atalhos privados do monorepo, não contratos estáveis
de plugins. Use subcaminhos genéricos e estreitos do SDK em vez disso. Dentro do workspace de
plugins empacotados, mantenha auxiliares pertencentes ao provedor no próprio api.ts ou
runtime-api.ts desse plugin.
Exemplos atuais de provedores empacotados:
- Anthropic mantém auxiliares de stream específicos do Claude em seu próprio seam
api.ts/contract-api.ts - OpenAI mantém builders de provedor, auxiliares de modelo padrão e builders de provedor
realtime em seu próprio
api.ts - OpenRouter mantém builder de provedor e auxiliares de onboarding/configuração em seu próprio
api.ts
Plano de migração de voz Talk e realtime
Código de voz realtime, telefonia, reuniões e Talk no navegador está migrando do bookkeeping local de superfície para um controlador compartilhado de sessão Talk exportado poropenclaw/plugin-sdk/realtime-voice. O novo controlador é responsável pelo envelope comum de eventos Talk,
estado de turno ativo, estado de captura, estado de áudio de saída, histórico recente
de eventos e rejeição de turnos obsoletos. Plugins de provedor devem continuar sendo responsáveis por
sessões realtime específicas do fornecedor; plugins de superfície devem continuar sendo responsáveis por captura,
reprodução, telefonia e particularidades de reuniões.
Esta migração de Talk é intencionalmente incompatível e limpa:
- Mantenha os primitivos compartilhados de controlador/runtime em
plugin-sdk/realtime-voice. - Migre as superfícies empacotadas para o controlador compartilhado: relay do navegador, handoff de sala gerenciada, realtime de chamada de voz, STT streaming de chamada de voz, Google Meet realtime e push-to-talk nativo.
- Substitua as famílias antigas de RPC Talk pela API final
talk.session.*etalk.client.*. - Anuncie um canal de eventos Talk ao vivo no Gateway
hello-ok.features.events:talk.event. - Exclua o endpoint HTTP realtime antigo e qualquer caminho de substituição de instruções em tempo de requisição.
createTalkEventSequencer(...) diretamente, a menos que esteja
implementando um adaptador de baixo nível ou fixture de teste. Prefira o controlador compartilhado
para que eventos com escopo de turno não possam ser emitidos sem um id de turno, chamadas obsoletas de turnEnd /
turnCancel não possam limpar um turno ativo mais recente, e eventos de ciclo de vida
de áudio de saída permaneçam consistentes entre telefonia, reuniões, relay do navegador, handoff de sala gerenciada
e clientes Talk nativos.
O formato alvo da API pública é:
talk.client.create,
porque o navegador é responsável pela negociação do provedor e pelo transporte de mídia, enquanto o
Gateway é responsável por credenciais, instruções e política de ferramentas. talk.session.* é a
superfície comum gerenciada pelo Gateway para sessões realtime por gateway-relay, transcrição por gateway-relay
e STT/TTS nativo de sala gerenciada.
Configurações legadas que colocavam seletores realtime ao lado de talk.provider /
talk.providers devem ser reparadas com openclaw doctor --fix; o Talk em runtime
não reinterpreta configuração de provedor de fala/TTS como configuração de provedor realtime.
As combinações compatíveis de talk.session.create são intencionalmente pequenas:
| Modo | Transporte | Cérebro | Proprietário | Observações |
|---|---|---|---|---|
realtime | gateway-relay | agent-consult | Gateway | Áudio full-duplex do provedor conectado por meio do Gateway; chamadas de ferramentas são roteadas pela ferramenta agent-consult. |
transcription | gateway-relay | none | Gateway | Apenas STT streaming; chamadores enviam áudio de entrada e recebem eventos de transcrição. |
stt-tts | managed-room | agent-consult | Sala nativa/cliente | Salas no estilo push-to-talk e walkie-talkie em que o cliente é responsável por captura/reprodução e o Gateway pelo estado do turno. |
stt-tts | managed-room | direct-tools | Sala nativa/cliente | Modo de sala somente para administradores em superfícies próprias confiáveis que executam ações de ferramentas do Gateway diretamente. |
| Antigo | Novo |
|---|---|
talk.realtime.session | talk.client.create |
talk.realtime.toolCall | talk.client.toolCall |
talk.realtime.relayAudio | talk.session.appendAudio |
talk.realtime.relayCancel | talk.session.cancelOutput ou talk.session.cancelTurn |
talk.realtime.relayToolResult | talk.session.submitToolResult |
talk.realtime.relayStop | talk.session.close |
talk.transcription.session | talk.session.create({ mode: "transcription" }) |
talk.transcription.relayAudio | talk.session.appendAudio |
talk.transcription.relayCancel | talk.session.cancelTurn |
talk.transcription.relayStop | talk.session.close |
talk.handoff.create | talk.session.create({ transport: "managed-room" }) |
talk.handoff.join | talk.session.join |
talk.handoff.revoke | talk.session.close |
| Método | Aplica-se a | Contrato |
|---|---|---|
talk.session.appendAudio | realtime/gateway-relay, transcription/gateway-relay | Anexa um bloco de áudio PCM em base64 à sessão do provedor pertencente à mesma conexão do Gateway. |
talk.session.startTurn | stt-tts/managed-room | Inicia um turno de usuário em sala gerenciada. |
talk.session.endTurn | stt-tts/managed-room | Encerra o turno ativo após validação de turno obsoleto. |
talk.session.cancelTurn | todas as sessões pertencentes ao Gateway | Cancela trabalho ativo de captura/provedor/agente/TTS de um turno. |
talk.session.cancelOutput | realtime/gateway-relay | Interrompe a saída de áudio do assistente sem necessariamente encerrar o turno do usuário. |
talk.session.submitToolResult | realtime/gateway-relay | Conclui uma chamada de ferramenta de provedor emitida pelo relay; passe options.willContinue para saída intermediária ou options.suppressResponse para satisfazer a chamada sem outra resposta do assistente. |
talk.session.close | todas as sessões unificadas | Interrompe sessões de relay ou revoga o estado de sala gerenciada, depois esquece o id unificado da sessão. |
Política de compatibilidade
Para plugins externos, o trabalho de compatibilidade segue esta ordem:- adicionar o novo contrato
- manter o comportamento antigo conectado por meio de um adaptador de compatibilidade
- emitir um diagnóstico ou aviso que nomeie o caminho antigo e a substituição
- cobrir ambos os caminhos em testes
- documentar a descontinuação e o caminho de migração
- remover somente após a janela de migração anunciada, geralmente em uma versão principal
pnpm plugins:boundary-report. Use pnpm plugins:boundary-report:summary para
contagens compactas, --owner <id> para um Plugin ou dono de compatibilidade, e
pnpm plugins:boundary-report:ci quando um gate de CI deve falhar em registros
de compatibilidade vencidos, imports de SDK reservados entre donos ou subpaths
de SDK reservados não usados. O relatório agrupa registros de compatibilidade
descontinuados por data de remoção, conta referências locais em código/docs,
expõe imports de SDK reservados entre donos e resume a ponte privada de SDK do
host de memória para que a limpeza de compatibilidade permaneça explícita em vez
de depender de buscas ad hoc. Subpaths de SDK reservados devem ter uso de dono
rastreado; exports de helpers reservados não usados devem ser removidos do SDK público.
Se um campo de manifesto ainda for aceito, autores de plugins podem continuar
usando-o até que a documentação e os diagnósticos digam o contrário. Código novo
deve preferir a substituição documentada, mas plugins existentes não devem quebrar
durante versões secundárias comuns.
Como migrar
Migrar helpers de carregamento/gravação de configuração de runtime
api.runtime.config.loadConfig() e
api.runtime.config.writeConfigFile(...) diretamente. Prefira a configuração que já foi
passada para o caminho de chamada ativo. Handlers de longa duração que precisam do
snapshot do processo atual podem usar api.runtime.config.current(). Ferramentas de
agente de longa duração devem usar ctx.getRuntimeConfig() do contexto da ferramenta dentro de
execute para que uma ferramenta criada antes de uma gravação de configuração ainda veja a
configuração de runtime atualizada.Gravações de configuração devem passar pelos helpers transacionais e escolher uma
política pós-gravação:afterWrite: { mode: "restart", reason: "..." } quando o chamador souber
que a mudança exige uma reinicialização limpa do Gateway, e
afterWrite: { mode: "none", reason: "..." } somente quando o chamador for dono do
acompanhamento e quiser deliberadamente suprimir o planejador de recarregamento.
Resultados de mutação incluem um resumo followUp tipado para testes e logging;
o Gateway continua responsável por aplicar ou agendar a reinicialização.
loadConfig e writeConfigFile permanecem como helpers de compatibilidade
descontinuados para plugins externos durante a janela de migração e avisam uma vez com
o código de compatibilidade runtime-config-load-write. Plugins incluídos e código de
runtime do repositório são protegidos por guardrails de scanner em
pnpm check:deprecated-api-usage e
pnpm check:no-runtime-action-load-config: novo uso em Plugin de produção
falha imediatamente, gravações diretas de configuração falham, métodos do servidor Gateway devem usar
o snapshot de runtime da requisição, helpers de envio/ação/cliente de canal em runtime
devem receber configuração de sua fronteira, e módulos de runtime de longa duração têm
zero chamadas ambiente loadConfig() permitidas.Novo código de Plugin também deve evitar importar o barrel amplo de compatibilidade
openclaw/plugin-sdk/config-runtime. Use o subpath estreito do SDK
correspondente ao trabalho:| Necessidade | Import |
|---|---|
Tipos de configuração como OpenClawConfig | openclaw/plugin-sdk/config-contracts |
| Asserções de configuração já carregada e busca de configuração de entrada de Plugin | openclaw/plugin-sdk/plugin-config-runtime |
| Leituras do snapshot de runtime atual | openclaw/plugin-sdk/runtime-config-snapshot |
| Gravações de configuração | openclaw/plugin-sdk/config-mutation |
| Helpers de armazenamento de sessão | openclaw/plugin-sdk/session-store-runtime |
| Configuração de tabela Markdown | openclaw/plugin-sdk/markdown-table-runtime |
| Helpers de runtime de política de grupo | openclaw/plugin-sdk/runtime-group-policy |
| Resolução de entrada secreta | openclaw/plugin-sdk/secret-input-runtime |
| Sobrescritas de modelo/sessão | openclaw/plugin-sdk/model-session-runtime |
Migrar extensões de resultado de ferramenta do Pi para middleware
api.registerEmbeddedExtensionFactory(...) por middleware neutro em relação a runtime.Migrar handlers nativos de aprovação para fatos de capacidade
approvalCapability.nativeRuntime mais o registro compartilhado de contexto de runtime.Principais mudanças:- Substitua
approvalCapability.handler.loadRuntime(...)porapprovalCapability.nativeRuntime - Mova auth/entrega específicos de aprovação para fora do cabeamento legado
plugin.auth/plugin.approvalse paraapprovalCapability ChannelPlugin.approvalsfoi removido do contrato público de Plugin de canal; mova campos de entrega/nativo/renderização paraapprovalCapabilityplugin.authpermanece apenas para fluxos de login/logout de canal; hooks de auth de aprovação ali não são mais lidos pelo core- Registre objetos de runtime pertencentes ao canal, como clientes, tokens ou aplicativos Bolt,
por meio de
openclaw/plugin-sdk/channel-runtime-context - Não envie avisos de redirecionamento pertencentes ao Plugin a partir de handlers nativos de aprovação; agora o core é dono dos avisos de roteado-para-outro-lugar a partir de resultados reais de entrega
- Ao passar
channelRuntimeparacreateChannelManager(...), forneça uma superfície realcreatePluginRuntime().channel. Stubs parciais são rejeitados.
/plugins/sdk-channel-plugins para o layout atual de capacidade de aprovação.Auditar comportamento de fallback do wrapper do Windows
openclaw/plugin-sdk/windows-spawn, wrappers Windows
.cmd/.bat não resolvidos agora falham fechados, a menos que você passe explicitamente
allowShellFallback: true.allowShellFallback e trate o erro lançado em vez disso.Encontrar imports descontinuados
Substituir por imports focados
| Import antigo | Equivalente moderno |
|---|---|
resolveAgentDir | api.runtime.agent.resolveAgentDir |
resolveAgentWorkspaceDir | api.runtime.agent.resolveAgentWorkspaceDir |
resolveAgentIdentity | api.runtime.agent.resolveAgentIdentity |
resolveThinkingDefault | api.runtime.agent.resolveThinkingDefault |
resolveAgentTimeoutMs | api.runtime.agent.resolveAgentTimeoutMs |
ensureAgentWorkspace | api.runtime.agent.ensureAgentWorkspace |
| helpers de armazenamento de sessão | api.runtime.agent.session.* |
Substituir imports amplos de infra-runtime
openclaw/plugin-sdk/infra-runtime ainda existe para compatibilidade
externa, mas código novo deve importar a superfície de helper focada de que
realmente precisa:| Necessidade | Import |
|---|---|
| Helpers de fila de eventos do sistema | openclaw/plugin-sdk/system-event-runtime |
| Helpers de ativação, evento e visibilidade de Heartbeat | openclaw/plugin-sdk/heartbeat-runtime |
| Drenagem de fila de entrega pendente | openclaw/plugin-sdk/delivery-queue-runtime |
| Telemetria de atividade de canal | openclaw/plugin-sdk/channel-activity-runtime |
| Caches de deduplicação em memória | openclaw/plugin-sdk/dedupe-runtime |
| Helpers seguros de caminho de arquivo local/mídia | openclaw/plugin-sdk/file-access-runtime |
| Fetch ciente de dispatcher | openclaw/plugin-sdk/runtime-fetch |
| Helpers de proxy e fetch protegido | openclaw/plugin-sdk/fetch-runtime |
| Tipos de política de dispatcher SSRF | openclaw/plugin-sdk/ssrf-dispatcher |
| Tipos de requisição/resolução de aprovação | openclaw/plugin-sdk/approval-runtime |
| Payload de resposta de aprovação e helpers de comando | openclaw/plugin-sdk/approval-reply-runtime |
| Helpers de formatação de erro | openclaw/plugin-sdk/error-runtime |
| Esperas de prontidão de transporte | openclaw/plugin-sdk/transport-ready-runtime |
| Helpers de token seguro | openclaw/plugin-sdk/secure-random-runtime |
| Concorrência limitada de tarefas assíncronas | openclaw/plugin-sdk/concurrency-runtime |
| Coerção numérica | openclaw/plugin-sdk/number-runtime |
| Lock assíncrono local ao processo | openclaw/plugin-sdk/async-lock-runtime |
| Locks de arquivo | openclaw/plugin-sdk/file-lock |
infra-runtime, então o código do repositório
não pode regredir para o barrel amplo.Migrar helpers de rota de canal
openclaw/plugin-sdk/channel-route.
Os nomes mais antigos de chave de rota e alvo comparável permanecem como aliases de compatibilidade
durante a janela de migração, mas novos plugins devem usar os nomes de rota
que descrevem o comportamento diretamente:| Helper antigo | Helper moderno |
|---|---|
channelRouteIdentityKey(...) | channelRouteDedupeKey(...) |
channelRouteKey(...) | channelRouteCompactKey(...) |
ComparableChannelTarget | ChannelRouteParsedTarget |
resolveComparableTargetForChannel(...) | resolveRouteTargetForChannel(...) |
resolveComparableTargetForLoadedChannel(...) | resolveRouteTargetForLoadedChannel(...) |
comparableChannelTargetsMatch(...) | channelRouteTargetsMatchExact(...) |
comparableChannelTargetsShareRoute(...) | channelRouteTargetsShareConversation(...) |
{ channel, to, accountId, threadId }
de forma consistente entre aprovações nativas, supressão de respostas, desduplicação
de entrada, entrega via Cron e roteamento de sessões. Se o seu Plugin possui uma
gramática de destino personalizada, use resolveChannelRouteTargetWithParser(...)
para adaptar esse analisador ao mesmo contrato de destino de rota.Referência de caminho de importação
Common import path table
Common import path table
| Caminho de importação | Finalidade | Exportações principais |
|---|---|---|
plugin-sdk/plugin-entry | Auxiliar canônico de entrada de plugin | definePluginEntry |
plugin-sdk/core | Reexportação guarda-chuva legada para definições/construtores de entrada de canal | defineChannelPluginEntry, createChatChannelPlugin |
plugin-sdk/config-schema | Exportação do esquema de configuração raiz | OpenClawSchema |
plugin-sdk/provider-entry | Auxiliar de entrada de provedor único | defineSingleProviderPluginEntry |
plugin-sdk/channel-core | Definições e construtores focados de entrada de canal | defineChannelPluginEntry, defineSetupPluginEntry, createChatChannelPlugin, createChannelPluginBase |
plugin-sdk/setup | Auxiliares compartilhados do assistente de configuração | Prompts de lista de permissões, construtores de status de configuração |
plugin-sdk/setup-runtime | Auxiliares de runtime no momento da configuração | Adaptadores de patch de configuração seguros para importação, auxiliares de notas de consulta, promptResolvedAllowFrom, splitSetupEntries, proxies de configuração delegada |
plugin-sdk/setup-adapter-runtime | Alias obsoleto do adaptador de configuração | Use plugin-sdk/setup-runtime |
plugin-sdk/setup-tools | Auxiliares de ferramentas de configuração | formatCliCommand, detectBinary, extractArchive, resolveBrewExecutable, formatDocsLink, CONFIG_DIR |
plugin-sdk/account-core | Auxiliares de várias contas | Auxiliares de lista/configuração/controle de ação de contas |
plugin-sdk/account-id | Auxiliares de ID de conta | DEFAULT_ACCOUNT_ID, normalização de ID de conta |
plugin-sdk/account-resolution | Auxiliares de consulta de conta | Auxiliares de consulta de conta + fallback padrão |
plugin-sdk/account-helpers | Auxiliares estreitos de conta | Auxiliares de lista de contas/ação de conta |
plugin-sdk/channel-setup | Adaptadores do assistente de configuração | createOptionalChannelSetupSurface, createOptionalChannelSetupAdapter, createOptionalChannelSetupWizard, mais DEFAULT_ACCOUNT_ID, createTopLevelChannelDmPolicy, setSetupChannelEnabled, splitSetupEntries |
plugin-sdk/channel-pairing | Primitivas de pareamento de DM | createChannelPairingController |
plugin-sdk/channel-reply-pipeline | Cabeamento de prefixo de resposta, digitação e entrega de origem | createChannelReplyPipeline, resolveChannelSourceReplyDeliveryMode |
plugin-sdk/channel-config-helpers | Fábricas de adaptadores de configuração e auxiliares de acesso a DM | createHybridChannelConfigAdapter, resolveChannelDmAccess, resolveChannelDmAllowFrom, resolveChannelDmPolicy, normalizeChannelDmPolicy, normalizeLegacyDmAliases |
plugin-sdk/channel-config-schema | Construtores de esquema de configuração | Apenas primitivas compartilhadas de esquema de configuração de canal e o construtor genérico |
plugin-sdk/bundled-channel-config-schema | Esquemas de configuração empacotados | Apenas plugins empacotados mantidos pelo OpenClaw; novos plugins devem definir esquemas locais do plugin |
plugin-sdk/channel-config-schema-legacy | Esquemas de configuração empacotados obsoletos | Apenas alias de compatibilidade; use plugin-sdk/bundled-channel-config-schema para plugins empacotados mantidos |
plugin-sdk/telegram-command-config | Auxiliares de configuração de comandos do Telegram | Normalização de nome de comando, corte de descrição, validação de duplicidade/conflito |
plugin-sdk/channel-policy | Resolução de política de grupo/DM | resolveChannelGroupRequireMention |
plugin-sdk/channel-lifecycle | Auxiliares de status de conta e ciclo de vida de stream de rascunho | createAccountStatusSink, auxiliares de finalização de prévia de rascunho |
plugin-sdk/inbound-envelope | Auxiliares de envelope de entrada | Auxiliares compartilhados de rota + construtor de envelope |
plugin-sdk/inbound-reply-dispatch | Auxiliares de resposta de entrada | Auxiliares compartilhados de registro e despacho |
plugin-sdk/messaging-targets | Análise de destino de mensagens | Auxiliares de análise/correspondência de destino |
plugin-sdk/outbound-media | Auxiliares de mídia de saída | Carregamento compartilhado de mídia de saída |
plugin-sdk/outbound-send-deps | Auxiliares de dependência de envio de saída | Consulta leve de resolveOutboundSendDep sem importar o runtime de saída completo |
plugin-sdk/outbound-runtime | Auxiliares de runtime de saída | Auxiliares de entrega de saída, delegado de identidade/envio, sessão, formatação e planejamento de payload |
plugin-sdk/thread-bindings-runtime | Auxiliares de vinculação de thread | Auxiliares de ciclo de vida e adaptador de vinculação de thread |
plugin-sdk/agent-media-payload | Auxiliares legados de payload de mídia | Construtor de payload de mídia de agente para layouts de campo legados |
plugin-sdk/channel-runtime | Shim de compatibilidade obsoleto | Apenas utilitários legados de runtime de canal |
plugin-sdk/channel-send-result | Tipos de resultado de envio | Tipos de resultado de resposta |
plugin-sdk/runtime-store | Armazenamento persistente de plugin | createPluginRuntimeStore |
plugin-sdk/runtime | Auxiliares amplos de runtime | Auxiliares de runtime/logging/backup/instalação de plugin |
plugin-sdk/runtime-env | Auxiliares estreitos de ambiente de runtime | Auxiliares de logger/ambiente de runtime, timeout, nova tentativa e backoff |
plugin-sdk/plugin-runtime | Auxiliares compartilhados de runtime de plugin | Auxiliares de comandos/hooks/http/interativos de plugin |
plugin-sdk/hook-runtime | Auxiliares de pipeline de hook | Auxiliares compartilhados de pipeline de webhook/hook interno |
plugin-sdk/lazy-runtime | Auxiliares de runtime lazy | createLazyRuntimeModule, createLazyRuntimeMethod, createLazyRuntimeMethodBinder, createLazyRuntimeNamedExport, createLazyRuntimeSurface |
plugin-sdk/process-runtime | Auxiliares de processo | Auxiliares compartilhados de exec |
plugin-sdk/cli-runtime | Auxiliares de runtime da CLI | Formatação de comandos, esperas, auxiliares de versão |
plugin-sdk/gateway-runtime | Auxiliares de Gateway | Cliente de Gateway, auxiliar de inicialização pronto para loop de eventos e auxiliares de patch de status de canal |
plugin-sdk/config-runtime | Shim obsoleto de compatibilidade de configuração | Prefira config-contracts, plugin-config-runtime, runtime-config-snapshot e config-mutation |
plugin-sdk/telegram-command-config | Auxiliares de comandos do Telegram | Auxiliares de validação de comandos do Telegram com fallback estável quando a superfície de contrato do Telegram empacotado está indisponível |
plugin-sdk/approval-runtime | Auxiliares de prompt de aprovação | Payload de aprovação de exec/plugin, auxiliares de capacidade/perfil de aprovação, roteamento/runtime de aprovação nativa e formatação de caminho de exibição de aprovação estruturada |
plugin-sdk/approval-auth-runtime | Auxiliares de autenticação de aprovação | Resolução de aprovador, autenticação de ação no mesmo chat |
plugin-sdk/approval-client-runtime | Auxiliares de cliente de aprovação | Auxiliares de perfil/filtro de aprovação nativa de exec |
plugin-sdk/approval-delivery-runtime | Auxiliares de entrega de aprovação | Adaptadores de capacidade/entrega de aprovação nativa |
plugin-sdk/approval-gateway-runtime | Auxiliares de Gateway de aprovação | Auxiliar compartilhado de resolução de Gateway de aprovação |
plugin-sdk/approval-handler-adapter-runtime | Auxiliares de adaptador de aprovação | Auxiliares leves de carregamento de adaptador de aprovação nativa para entrypoints de canal críticos |
plugin-sdk/approval-handler-runtime | Auxiliares de handler de aprovação | Auxiliares mais amplos de runtime de handler de aprovação; prefira as interfaces estreitas de adaptador/Gateway quando forem suficientes |
plugin-sdk/approval-native-runtime | Auxiliares de destino de aprovação | Auxiliares de vinculação de destino/conta de aprovação nativa |
plugin-sdk/approval-reply-runtime | Auxiliares de resposta de aprovação | Auxiliares de payload de resposta de aprovação de exec/plugin |
plugin-sdk/channel-runtime-context | Auxiliares de contexto de runtime de canal | Auxiliares genéricos de registrar/obter/observar contexto de runtime de canal |
plugin-sdk/security-runtime | Auxiliares de segurança | Auxiliares compartilhados de confiança, controle de DM, arquivo/caminho delimitado à raiz, conteúdo externo e coleta de segredos |
plugin-sdk/ssrf-policy | Auxiliares de política SSRF | Auxiliares de lista de permissões de hosts e política de rede privada |
plugin-sdk/ssrf-runtime | Auxiliares de runtime SSRF | Dispatcher fixado, fetch protegido, auxiliares de política SSRF |
plugin-sdk/system-event-runtime | Auxiliares de evento do sistema | enqueueSystemEvent, peekSystemEventEntries |
plugin-sdk/heartbeat-runtime | Auxiliares de Heartbeat | Auxiliares de despertar, evento e visibilidade de Heartbeat |
plugin-sdk/delivery-queue-runtime | Auxiliares de fila de entrega | drainPendingDeliveries |
plugin-sdk/channel-activity-runtime | Auxiliares de atividade de canal | recordChannelActivity |
plugin-sdk/dedupe-runtime | Auxiliares de dedupe | Caches de dedupe em memória |
plugin-sdk/file-access-runtime | Auxiliares de acesso a arquivos | Auxiliares seguros de caminho de arquivo/mídia local |
plugin-sdk/transport-ready-runtime | Auxiliares de prontidão de transporte | waitForTransportReady |
plugin-sdk/collection-runtime | Auxiliares de cache limitado | pruneMapToMaxSize |
plugin-sdk/diagnostic-runtime | Auxiliares de controle de diagnóstico | isDiagnosticFlagEnabled, isDiagnosticsEnabled |
plugin-sdk/error-runtime | Auxiliares de formatação de erros | formatUncaughtError, isApprovalNotFoundError, auxiliares de grafo de erros |
plugin-sdk/fetch-runtime | Auxiliares de fetch/proxy encapsulados | resolveFetch, auxiliares de proxy, auxiliares de opções de EnvHttpProxyAgent |
plugin-sdk/host-runtime | Auxiliares de normalização de host | normalizeHostname, normalizeScpRemoteHost |
plugin-sdk/retry-runtime | Auxiliares de nova tentativa | RetryConfig, retryAsync, executores de política |
plugin-sdk/allow-from | Formatação de lista de permissões | formatAllowFromLowercase |
plugin-sdk/allowlist-resolution | Mapeamento de entrada de lista de permissões | mapAllowlistResolutionInputs |
plugin-sdk/command-auth | Auxiliares de controle de comandos e superfície de comandos | resolveControlCommandGate, auxiliares de autorização de remetente, auxiliares de registro de comandos incluindo formatação dinâmica de menu de argumentos |
plugin-sdk/command-status | Renderizadores de status/ajuda de comandos | buildCommandsMessage, buildCommandsMessagePaginated, buildHelpMessage |
plugin-sdk/secret-input | Análise de entrada secreta | Auxiliares de entrada secreta |
plugin-sdk/webhook-ingress | Auxiliares de requisição de Webhook | Utilitários de destino de Webhook |
plugin-sdk/webhook-request-guards | Auxiliares de proteção do corpo de Webhook | Auxiliares de leitura/limite de corpo da requisição |
plugin-sdk/reply-runtime | Runtime compartilhado de resposta | Despacho de entrada, heartbeat, planejador de resposta, fragmentação |
plugin-sdk/reply-dispatch-runtime | Auxiliares estreitos de despacho de resposta | Finalização, despacho de provedor e auxiliares de rótulo de conversa |
plugin-sdk/reply-history | Auxiliares de histórico de respostas | buildHistoryContext, buildPendingHistoryContextFromMap, recordPendingHistoryEntry, clearHistoryEntriesIfEnabled |
plugin-sdk/reply-reference | Planejamento de referência de resposta | createReplyReferencePlanner |
plugin-sdk/reply-chunking | Auxiliares de fragmentação de resposta | Auxiliares de fragmentação de texto/markdown |
plugin-sdk/session-store-runtime | Auxiliares de armazenamento de sessão | Auxiliares de caminho de armazenamento + updated-at |
plugin-sdk/state-paths | Auxiliares de caminho de estado | Auxiliares de diretório de estado e OAuth |
plugin-sdk/routing | Auxiliares de roteamento/chave de sessão | resolveAgentRoute, buildAgentSessionKey, resolveDefaultAgentBoundAccountId, auxiliares de normalização de chave de sessão |
plugin-sdk/status-helpers | Auxiliares de status de canal | Construtores de resumo de status de canal/conta, padrões de estado de runtime, auxiliares de metadados de problema |
plugin-sdk/target-resolver-runtime | Auxiliares de resolvedor de destino | Auxiliares compartilhados de resolvedor de destino |
plugin-sdk/string-normalization-runtime | Auxiliares de normalização de string | Auxiliares de normalização de slug/string |
plugin-sdk/request-url | Auxiliares de URL de requisição | Extrair URLs em string de entradas semelhantes a requisições |
plugin-sdk/run-command | Auxiliares de comando temporizado | Executor de comando temporizado com stdout/stderr normalizados |
plugin-sdk/param-readers | Leitores de parâmetros | Leitores comuns de parâmetros de ferramenta/CLI |
plugin-sdk/tool-payload | Extração de payload de ferramenta | Extrai payloads normalizados de objetos de resultado de ferramenta |
plugin-sdk/tool-send | Extração de envio de ferramenta | Extrai campos canônicos de destino de envio de argumentos de ferramenta |
plugin-sdk/temp-path | Auxiliares de caminho temporário | Auxiliares compartilhados de caminho de download temporário |
plugin-sdk/logging-core | Auxiliares de registro | Auxiliares de logger de subsistema e redação |
plugin-sdk/markdown-table-runtime | Auxiliares de tabela Markdown | Auxiliares de modo de tabela Markdown |
plugin-sdk/reply-payload | Tipos de resposta de mensagem | Tipos de payload de resposta |
plugin-sdk/provider-setup | Auxiliares selecionados de configuração de provedor local/auto-hospedado | Auxiliares de descoberta/configuração de provedor auto-hospedado |
plugin-sdk/self-hosted-provider-setup | Auxiliares focados de configuração de provedor auto-hospedado compatível com OpenAI | Mesmos auxiliares de descoberta/configuração de provedor auto-hospedado |
plugin-sdk/provider-auth-runtime | Auxiliares de autenticação em tempo de execução do provedor | Auxiliares de resolução de chave de API em tempo de execução |
plugin-sdk/provider-auth-api-key | Auxiliares de configuração de chave de API do provedor | Auxiliares de integração/gravação de perfil de chave de API |
plugin-sdk/provider-auth-result | Auxiliares de resultado de autenticação do provedor | Construtor padrão de resultado de autenticação OAuth |
plugin-sdk/provider-selection-runtime | Auxiliares de seleção de provedor | Seleção de provedor configurado ou automático e mesclagem de configuração bruta do provedor |
plugin-sdk/provider-env-vars | Auxiliares de variáveis de ambiente do provedor | Auxiliares de busca de variáveis de ambiente de autenticação do provedor |
plugin-sdk/provider-model-shared | Auxiliares compartilhados de modelo/repetição de provedor | ProviderReplayFamily, buildProviderReplayFamilyHooks, normalizeModelCompat, construtores compartilhados de política de repetição, auxiliares de endpoint de provedor e auxiliares de normalização de ID de modelo |
plugin-sdk/provider-catalog-shared | Auxiliares compartilhados de catálogo de provedor | findCatalogTemplate, buildSingleProviderApiKeyCatalog, buildManifestModelProviderConfig, supportsNativeStreamingUsageCompat, applyProviderNativeStreamingUsageCompat |
plugin-sdk/provider-onboard | Patches de integração de provedor | Auxiliares de configuração de integração |
plugin-sdk/provider-http | Auxiliares HTTP de provedor | Auxiliares genéricos de capacidade HTTP/endpoint de provedor, incluindo auxiliares de formulário multipart para transcrição de áudio |
plugin-sdk/provider-web-fetch | Auxiliares de busca web de provedor | Auxiliares de registro/cache de provedor de busca web |
plugin-sdk/provider-web-search-config-contract | Auxiliares de configuração de pesquisa web de provedor | Auxiliares restritos de configuração/credenciais de pesquisa web para provedores que não precisam de fiação de ativação de Plugin |
plugin-sdk/provider-web-search-contract | Auxiliares de contrato de pesquisa web de provedor | Auxiliares restritos de contrato de configuração/credenciais de pesquisa web, como createWebSearchProviderContractFields, enablePluginInConfig, resolveProviderWebSearchPluginConfig e setters/getters de credenciais com escopo |
plugin-sdk/provider-web-search | Auxiliares de pesquisa web de provedor | Auxiliares de registro/cache/tempo de execução de provedor de pesquisa web |
plugin-sdk/provider-tools | Auxiliares de compatibilidade de ferramentas/esquema de provedor | ProviderToolCompatFamily, buildProviderToolCompatFamilyHooks e limpeza + diagnósticos de esquema Gemini |
plugin-sdk/provider-usage | Auxiliares de uso de provedor | fetchClaudeUsage, fetchGeminiUsage, fetchGithubCopilotUsage e outros auxiliares de uso de provedor |
plugin-sdk/provider-stream | Auxiliares de wrapper de fluxo de provedor | ProviderStreamFamily, buildProviderStreamFamilyHooks, composeProviderStreamWrappers, tipos de wrapper de fluxo e auxiliares compartilhados de wrapper Anthropic/Bedrock/DeepSeek V4/Google/Kilocode/Moonshot/OpenAI/OpenRouter/Z.A.I/MiniMax/Copilot |
plugin-sdk/provider-transport-runtime | Auxiliares de transporte de provedor | Auxiliares de transporte nativo de provedor, como fetch protegido, transformações de mensagens de transporte e fluxos graváveis de eventos de transporte |
plugin-sdk/keyed-async-queue | Fila assíncrona ordenada | KeyedAsyncQueue |
plugin-sdk/media-runtime | Auxiliares de mídia compartilhados | Auxiliares de busca/transformação/armazenamento de mídia, sondagem de dimensões de vídeo baseada em ffprobe e construtores de payload de mídia |
plugin-sdk/media-generation-runtime | Auxiliares compartilhados de geração de mídia | Auxiliares compartilhados de failover, seleção de candidatos e mensagens de modelo ausente para geração de imagem/vídeo/música |
plugin-sdk/media-understanding | Auxiliares de compreensão de mídia | Tipos de provedor de compreensão de mídia mais exportações de auxiliares de imagem/áudio voltados para provedor |
plugin-sdk/text-runtime | Exportação ampla obsoleta de compatibilidade de texto | Use string-coerce-runtime, text-chunking, text-utility-runtime e logging-core |
plugin-sdk/text-chunking | Auxiliares de fragmentação de texto | Auxiliar de fragmentação de texto de saída |
plugin-sdk/speech | Auxiliares de fala | Tipos de provedor de fala mais auxiliares de diretiva, registro e validação voltados para provedor, e construtor de TTS compatível com OpenAI |
plugin-sdk/speech-core | Núcleo compartilhado de fala | Tipos de provedor de fala, registro, diretivas, normalização |
plugin-sdk/realtime-transcription | Auxiliares de transcrição em tempo real | Tipos de provedor, auxiliares de registro e auxiliar compartilhado de sessão WebSocket |
plugin-sdk/realtime-voice | Auxiliares de voz em tempo real | Tipos de provedor, auxiliares de registro/resolução, auxiliares de sessão de ponte, filas compartilhadas de resposta falada do agente, integridade de transcrição/evento, supressão de eco e auxiliares de consulta rápida de contexto |
plugin-sdk/image-generation | Auxiliares de geração de imagem | Tipos de provedor de geração de imagem mais auxiliares de ativo de imagem/URL de dados e o construtor de provedor de imagem compatível com OpenAI |
plugin-sdk/image-generation-core | Núcleo compartilhado de geração de imagem | Tipos de geração de imagem, failover, autenticação e auxiliares de registro |
plugin-sdk/music-generation | Auxiliares de geração de música | Tipos de provedor/solicitação/resultado de geração de música |
plugin-sdk/music-generation-core | Núcleo compartilhado de geração de música | Tipos de geração de música, auxiliares de failover, busca de provedor e análise de ref de modelo |
plugin-sdk/video-generation | Auxiliares de geração de vídeo | Tipos de provedor/solicitação/resultado de geração de vídeo |
plugin-sdk/video-generation-core | Núcleo compartilhado de geração de vídeo | Tipos de geração de vídeo, auxiliares de failover, busca de provedor e análise de ref de modelo |
plugin-sdk/interactive-runtime | Auxiliares de resposta interativa | Normalização/redução de payload de resposta interativa |
plugin-sdk/channel-config-primitives | Primitivas de configuração de canal | Primitivas restritas de esquema de configuração de canal |
plugin-sdk/channel-config-writes | Auxiliares de gravação de configuração de canal | Auxiliares de autorização de gravação de configuração de canal |
plugin-sdk/channel-plugin-common | Prelúdio compartilhado de canal | Exportações compartilhadas de prelúdio de Plugin de canal |
plugin-sdk/channel-status | Auxiliares de status de canal | Auxiliares compartilhados de snapshot/resumo de status de canal |
plugin-sdk/allowlist-config-edit | Auxiliares de configuração de lista de permissões | Auxiliares de edição/leitura de configuração de lista de permissões |
plugin-sdk/group-access | Auxiliares de acesso a grupos | Auxiliares compartilhados de decisão de acesso a grupos |
plugin-sdk/direct-dm | Auxiliares de DM direta | Auxiliares compartilhados de autenticação/proteção de DM direta |
plugin-sdk/extension-shared | Auxiliares compartilhados de extensão | Primitivas de auxiliares de canal passivo/status e proxy ambiente |
plugin-sdk/webhook-targets | Auxiliares de destino de Webhook | Auxiliares de registro de destino de Webhook e instalação de rotas |
plugin-sdk/webhook-path | Alias obsoleto de caminho de webhook | Use plugin-sdk/webhook-ingress |
plugin-sdk/web-media | Auxiliares compartilhados de mídia web | Auxiliares de carregamento de mídia remota/local |
plugin-sdk/zod | Reexportação obsoleta de compatibilidade Zod | Importe zod de zod diretamente |
plugin-sdk/memory-core | Auxiliares memory-core empacotados | Superfície de auxiliares de gerenciador/configuração/arquivo/CLI de memória |
plugin-sdk/memory-core-engine-runtime | Fachada de tempo de execução do mecanismo de memória | Fachada de tempo de execução de índice/pesquisa de memória |
plugin-sdk/memory-core-host-engine-foundation | Mecanismo de base de host de memória | Exportações do mecanismo de base de host de memória |
plugin-sdk/memory-core-host-engine-embeddings | Mecanismo de embeddings de host de memória | Contratos de embedding de memória, acesso ao registro, provedor local e auxiliares genéricos de lote/remotos; provedores remotos concretos ficam nos Plugins que os possuem |
plugin-sdk/memory-core-host-engine-qmd | Mecanismo QMD de host de memória | Exportações do mecanismo QMD de host de memória |
plugin-sdk/memory-core-host-engine-storage | Mecanismo de armazenamento de host de memória | Exportações do mecanismo de armazenamento de host de memória |
plugin-sdk/memory-core-host-multimodal | Auxiliares multimodais de host de memória | Auxiliares multimodais de host de memória |
plugin-sdk/memory-core-host-query | Auxiliares de consulta de host de memória | Auxiliares de consulta de host de memória |
plugin-sdk/memory-core-host-secret | Auxiliares de segredo de host de memória | Auxiliares de segredo de host de memória |
plugin-sdk/memory-core-host-events | Alias obsoleto de evento de memória | Use plugin-sdk/memory-host-events |
plugin-sdk/memory-core-host-status | Auxiliares de status de host de memória | Auxiliares de status de host de memória |
plugin-sdk/memory-core-host-runtime-cli | Tempo de execução CLI de host de memória | Auxiliares de tempo de execução CLI de host de memória |
plugin-sdk/memory-core-host-runtime-core | Tempo de execução principal de host de memória | Auxiliares de tempo de execução principal de host de memória |
plugin-sdk/memory-core-host-runtime-files | Auxiliares de arquivo/tempo de execução de host de memória | Auxiliares de arquivo/tempo de execução de host de memória |
plugin-sdk/memory-host-core | Alias de tempo de execução principal de host de memória | Alias neutro em relação a fornecedor para auxiliares de tempo de execução principal de host de memória |
plugin-sdk/memory-host-events | Alias de diário de eventos de host de memória | Alias neutro em relação a fornecedor para auxiliares de diário de eventos de host de memória |
plugin-sdk/memory-host-files | Alias obsoleto de arquivo/tempo de execução de memória | Use plugin-sdk/memory-core-host-runtime-files |
plugin-sdk/memory-host-markdown | Auxiliares de markdown gerenciado | Auxiliares compartilhados de markdown gerenciado para Plugins adjacentes à memória |
plugin-sdk/memory-host-search | Fachada de pesquisa de Active Memory | Fachada de tempo de execução preguiçosa do gerenciador de pesquisa de Active Memory |
plugin-sdk/memory-host-status | Alias obsoleto de status de host de memória | Use plugin-sdk/memory-core-host-status |
plugin-sdk/testing | Utilitários de teste | Barrel de compatibilidade obsoleto local ao repositório; use subcaminhos de teste focados e locais ao repositório, como plugin-sdk/plugin-test-runtime, plugin-sdk/channel-test-helpers, plugin-sdk/channel-target-testing, plugin-sdk/test-env e plugin-sdk/test-fixtures |
scripts/lib/plugin-sdk-entrypoints.json; as exportações de pacote são geradas a partir
do subconjunto público.
As interfaces auxiliares reservadas dos plugins empacotados foram retiradas do mapa de
exportações público do SDK, exceto por facades de compatibilidade explicitamente
documentadas, como o shim obsoleto plugin-sdk/discord mantido para o pacote publicado
@openclaw/discord@2026.3.13. Auxiliares específicos do proprietário ficam dentro do
pacote do plugin proprietário; o comportamento compartilhado do host deve passar por
contratos genéricos do SDK, como plugin-sdk/gateway-runtime, plugin-sdk/security-runtime
e plugin-sdk/plugin-config-runtime.
Use a importação mais restrita que corresponda ao trabalho. Se você não encontrar uma exportação,
verifique o código-fonte em src/plugin-sdk/ ou pergunte aos mantenedores qual contrato
genérico deve ser responsável por ela.
Depreciações ativas
Depreciações mais restritas que se aplicam ao SDK de Plugin, ao contrato de provedor, à superfície de runtime e ao manifesto. Cada uma ainda funciona hoje, mas será removida em uma futura versão principal. A entrada abaixo de cada item mapeia a API antiga para sua substituição canônica.construtores de ajuda de command-auth → command-status
construtores de ajuda de command-auth → command-status
openclaw/plugin-sdk/command-auth): buildCommandsMessage,
buildCommandsMessagePaginated, buildHelpMessage.Novo (openclaw/plugin-sdk/command-status): mesmas assinaturas, mesmas
exportações - apenas importadas do subcaminho mais restrito. command-auth
as reexporta como stubs de compatibilidade.Auxiliares de bloqueio por menção → resolveInboundMentionDecision
Auxiliares de bloqueio por menção → resolveInboundMentionDecision
resolveInboundMentionRequirement({ facts, policy }) e
shouldDropInboundForMention(...) de
openclaw/plugin-sdk/channel-inbound ou
openclaw/plugin-sdk/channel-mention-gating.Novo: resolveInboundMentionDecision({ facts, policy }) - retorna um
único objeto de decisão em vez de duas chamadas separadas.Plugins de canal downstream (Slack, Discord, Matrix, MS Teams) já fizeram
a migração.Shim de runtime de canal e auxiliares de ações de canal
Shim de runtime de canal e auxiliares de ações de canal
openclaw/plugin-sdk/channel-runtime é um shim de compatibilidade para plugins
de canal mais antigos. Não o importe em código novo; use
openclaw/plugin-sdk/channel-runtime-context para registrar objetos de runtime.Auxiliares channelActions* em openclaw/plugin-sdk/channel-actions estão
obsoletos junto com exportações brutas de canal de “actions”. Exponha capacidades
pela superfície semântica presentation em vez disso - plugins de canal
declaram o que renderizam (cards, botões, selects) em vez de quais nomes de
ações brutas aceitam.Auxiliar tool() de provedor de pesquisa web → createTool() no plugin
Auxiliar tool() de provedor de pesquisa web → createTool() no plugin
tool() de openclaw/plugin-sdk/provider-web-search.Novo: implemente createTool(...) diretamente no plugin de provedor.
O OpenClaw não precisa mais do auxiliar do SDK para registrar o wrapper da ferramenta.Envelopes de canal em texto simples → BodyForAgent
Envelopes de canal em texto simples → BodyForAgent
formatInboundEnvelope(...) (e
ChannelMessageForAgent.channelEnvelope) para construir um envelope de prompt
em texto simples e plano a partir de mensagens de canal recebidas.Novo: BodyForAgent mais blocos estruturados de contexto do usuário. Plugins
de canal anexam metadados de roteamento (thread, tópico, responder a, reações) como
campos tipados em vez de concatená-los em uma string de prompt. O auxiliar
formatAgentEnvelope(...) ainda é compatível para envelopes sintetizados
voltados ao assistente, mas envelopes recebidos em texto simples estão
sendo descontinuados.Áreas afetadas: inbound_claim, message_received e qualquer plugin de
canal personalizado que pós-processava texto de channelEnvelope.Tipos de descoberta de provedor → tipos de catálogo de provedor
Tipos de descoberta de provedor → tipos de catálogo de provedor
| Alias antigo | Novo tipo |
|---|---|
ProviderDiscoveryOrder | ProviderCatalogOrder |
ProviderDiscoveryContext | ProviderCatalogContext |
ProviderDiscoveryResult | ProviderCatalogResult |
ProviderPluginDiscovery | ProviderPluginCatalog |
ProviderCapabilities - plugins de provedor
devem usar hooks explícitos de provedor, como buildReplayPolicy,
normalizeToolSchemas e wrapStreamFn, em vez de um objeto estático.Hooks de política de raciocínio → resolveThinkingProfile
Hooks de política de raciocínio → resolveThinkingProfile
ProviderThinkingPolicy):
isBinaryThinking(ctx), supportsXHighThinking(ctx) e
resolveDefaultThinkingLevel(ctx).Novo: um único resolveThinkingProfile(ctx) que retorna um
ProviderThinkingProfile com o id canônico, label opcional e lista
classificada de níveis. O OpenClaw faz downgrade automático de valores
armazenados obsoletos pela classificação do perfil.Implemente um hook em vez de três. Os hooks legados continuam funcionando
durante a janela de depreciação, mas não são compostos com o resultado do perfil.Fallback de provedor OAuth externo → contracts.externalAuthProviders
Fallback de provedor OAuth externo → contracts.externalAuthProviders
resolveExternalOAuthProfiles(...) sem
declarar o provedor no manifesto do plugin.Novo: declare contracts.externalAuthProviders no manifesto do plugin
e implemente resolveExternalAuthProfiles(...). O caminho antigo de
“auth fallback” emite um aviso em runtime e será removido.Consulta de variável de ambiente de provedor → setup.providers[].envVars
Consulta de variável de ambiente de provedor → setup.providers[].envVars
providerAuthEnvVars: { anthropic: ["ANTHROPIC_API_KEY"] }.Novo: espelhe a mesma consulta de variável de ambiente em setup.providers[].envVars
no manifesto. Isso consolida metadados de ambiente de configuração/status em um
só lugar e evita inicializar o runtime do plugin apenas para responder a consultas
de variáveis de ambiente.providerAuthEnvVars continua compatível por meio de um adaptador de compatibilidade
até o encerramento da janela de depreciação.Registro de plugin de memória → registerMemoryCapability
Registro de plugin de memória → registerMemoryCapability
api.registerMemoryPromptSection(...),
api.registerMemoryFlushPlan(...),
api.registerMemoryRuntime(...).Novo: uma chamada na API de estado de memória -
registerMemoryCapability(pluginId, { promptBuilder, flushPlanResolver, runtime }).Mesmos slots, uma única chamada de registro. Auxiliares aditivos de memória
(registerMemoryPromptSupplement, registerMemoryCorpusSupplement,
registerMemoryEmbeddingProvider) não são afetados.Tipos de mensagens de sessão de subagente renomeados
Tipos de mensagens de sessão de subagente renomeados
src/plugins/runtime/types.ts:| Antigo | Novo |
|---|---|
SubagentReadSessionParams | SubagentGetSessionMessagesParams |
SubagentReadSessionResult | SubagentGetSessionMessagesResult |
readSession está obsoleto em favor de
getSessionMessages. Mesma assinatura; o método antigo chama o novo.runtime.tasks.flow → runtime.tasks.managedFlows
runtime.tasks.flow → runtime.tasks.managedFlows
runtime.tasks.flow (singular) retornava um acessador ativo de task-flow.Novo: runtime.tasks.managedFlows mantém o runtime de mutação gerenciada
do TaskFlow para plugins que criam, atualizam, cancelam ou executam tarefas-filhas
a partir de um fluxo. Use runtime.tasks.flows quando o plugin só precisar
de leituras baseadas em DTO.Fábricas de extensão embutidas → middleware de resultado de ferramenta do agente
Fábricas de extensão embutidas → middleware de resultado de ferramenta do agente
api.registerEmbeddedExtensionFactory(...) foi substituído por
api.registerAgentToolResultMiddleware(...) com uma lista explícita de runtime
em contracts.agentToolResultMiddleware.Alias OpenClawSchemaType → OpenClawConfig
Alias OpenClawSchemaType → OpenClawConfig
OpenClawSchemaType reexportado de openclaw/plugin-sdk agora é um
alias de uma linha para OpenClawConfig. Prefira o nome canônico.extensions/) são acompanhadas dentro de seus próprios barrels api.ts e runtime-api.ts.
Elas não afetam contratos de plugins de terceiros e não estão listadas aqui. Se você
consome diretamente o barrel local de um plugin empacotado, leia os comentários de
depreciação nesse barrel antes de atualizar.Cronograma de remoção
| Quando | O que acontece |
|---|---|
| Agora | Superfícies obsoletas emitem avisos em runtime |
| Próxima versão principal | Superfícies obsoletas serão removidas; plugins que ainda as usam falharão |
Suprimindo temporariamente os avisos
Defina estas variáveis de ambiente enquanto trabalha na migração:Relacionados
- Introdução - crie seu primeiro plugin
- Visão geral do SDK - referência completa de importação por subcaminho
- Plugins de canal - criação de plugins de canal
- Plugins de provedor - criação de plugins de provedor
- Internos do Plugin - aprofundamento na arquitetura
- Manifesto do Plugin - referência do esquema do manifesto