Skip to main content
O SDK de plugins é exposto como um conjunto de subcaminhos públicos específicos em openclaw/plugin-sdk/. Esta página cataloga os subcaminhos mais usados, agrupados por finalidade. Três arquivos definem a superfície:
  • scripts/lib/plugin-sdk-entrypoints.json: o inventário de pontos de entrada mantido que a compilação compila.
  • scripts/lib/plugin-sdk-private-local-only-subpaths.json: subcaminhos internos/de teste locais do repositório. As exportações do pacote correspondem ao inventário menos esta lista.
  • src/plugin-sdk/entrypoints.ts: metadados de classificação para subcaminhos obsoletos, auxiliares integrados reservados, fachadas integradas compatíveis e superfícies públicas pertencentes a plugins.
Os mantenedores auditam a contagem de exportações públicas com pnpm plugin-sdk:surface e os subcaminhos ativos de auxiliares reservados com pnpm plugins:boundary-report:summary; exportações de auxiliares reservados não utilizadas fazem o relatório de CI falhar, em vez de permanecerem no SDK público como dívida de compatibilidade inativa. Para consultar o guia de criação de plugins, consulte a visão geral do SDK de plugins.

Entrada do Plugin

Auxiliares obsoletos de compatibilidade e teste

Os subcaminhos obsoletos continuam exportados para plugins mais antigos, mas códigos novos devem usar os subcaminhos específicos do SDK abaixo. A lista mantida é scripts/lib/plugin-sdk-deprecated-public-subpaths.json; a CI rejeita importações de produção integradas provenientes dela. Barris amplos como plugin-sdk/compat, plugin-sdk/config-types, plugin-sdk/infra-runtime e plugin-sdk/text-runtime servem apenas para compatibilidade, e plugin-sdk/zod é uma reexportação de compatibilidade: importe zod diretamente de zod. Os barris amplos de domínio plugin-sdk/agent-runtime, plugin-sdk/channel-lifecycle, plugin-sdk/channel-runtime, plugin-sdk/cli-runtime, plugin-sdk/conversation-runtime, plugin-sdk/hook-runtime, plugin-sdk/media-runtime, plugin-sdk/plugin-runtime e plugin-sdk/security-runtime também estão obsoletos em favor de subcaminhos específicos. Os subcaminhos de auxiliares de teste do OpenClaw baseados no Vitest são somente locais do repositório e não são mais exportações do pacote: agent-runtime-test-contracts, channel-contract-testing, channel-target-testing, channel-test-helpers, plugin-state-test-runtime, plugin-test-api, plugin-test-contracts, plugin-test-runtime, provider-http-test-mocks, provider-test-contracts, reply-payload-testing, sqlite-runtime-testing, test-env, test-fixtures, test-node-mocks e testing. As superfícies privadas de auxiliares integrados ssrf-runtime-internal e codex-native-task-runtime também são somente locais do repositório.

Subcaminhos reservados de auxiliares de plugins integrados

plugin-sdk/codex-mcp-projection é o único subcaminho reservado: uma superfície de compatibilidade pertencente ao plugin para o plugin Codex integrado, e não uma API geral do SDK. As importações de plugins entre proprietários são bloqueadas pelas proteções do contrato do pacote, e a CI falha quando um subcaminho reservado deixa de ser importado. plugin-sdk/codex-native-task-runtime é somente local do repositório e não é uma exportação do pacote. src/plugin-sdk/entrypoints.ts também rastreia fachadas integradas compatíveis, pontos de entrada do SDK providos pelos respectivos plugins integrados até que contratos genéricos os substituam: plugin-sdk/discord, plugin-sdk/lmstudio, plugin-sdk/lmstudio-runtime, plugin-sdk/matrix, plugin-sdk/mattermost, plugin-sdk/memory-core-engine-runtime, plugin-sdk/provider-zai-endpoint, plugin-sdk/qa-runner-runtime, plugin-sdk/telegram-account, plugin-sdk/tts-runtime e plugin-sdk/zalouser. Vários deles também estão obsoletos para códigos novos; consulte as observações de cada linha abaixo.
As famílias obsoletas de auxiliares de canal permanecem disponíveis apenas para compatibilidade com plugins publicados. O plano de remoção é: mantê-las durante a janela de migração de plugins externos, manter os plugins do repositório/incluídos em channel-inbound e channel-outbound e, em seguida, remover os subcaminhos de compatibilidade na próxima grande limpeza do SDK. Isso se aplica às antigas famílias de mensagens/runtime de canal, streaming de canal, acesso direto a DMs, auxiliares fragmentados de entrada, opções de resposta e caminhos de pareamento.
Os snapshots de uso de provedores normalmente relatam uma ou mais windows de cota, cada uma com um rótulo, percentual usado e horário opcional de redefinição. Provedores que expõem saldo ou texto de estado da conta em vez de janelas de cota redefiníveis devem retornar summary com um array windows vazio, em vez de fabricar percentuais. O OpenClaw exibe esse texto de resumo na saída de status; use error somente quando o endpoint de uso falhar ou não retornar dados de uso utilizáveis.
Os subcaminhos reservados do SDK para auxiliares integrados são superfícies específicas e restritas a cada proprietário para código de plugins integrados. Eles são rastreados no inventário do SDK para que as compilações de pacotes e os aliases permaneçam determinísticos, mas não são APIs gerais para criação de plugins. Novos contratos de host reutilizáveis devem usar subcaminhos genéricos do SDK, como plugin-sdk/gateway-runtime, plugin-sdk/ssrf-runtime e plugin-sdk/plugin-config-runtime.

Relacionados