Ir al contenido

Manifiesto de complemento

Esta página es solo para el manifiesto del complemento nativo de OpenClaw.

Para diseños de paquetes compatibles, consulte Plugin bundles.

Los formatos de paquete compatibles utilizan diferentes archivos de manifiesto:

  • Paquete Codex: .codex-plugin/plugin.json
  • Paquete Claude: .claude-plugin/plugin.json o el diseño predeterminado del componente Claude sin manifiesto
  • Paquete Cursor: .cursor-plugin/plugin.json

OpenClaw también detecta automáticamente esos diseños de paquetes, pero no se validan contra el esquema openclaw.plugin.json descrito aquí.

Para los paquetes compatibles, OpenClaw actualmente lee los metadatos del paquete más las raíces de habilidades declaradas, las raíces de comandos de Claude, los valores predeterminados del paquete Claude settings.json, los valores predeterminados de LSP del paquete Claude y los paquetes de enlace compatibles cuando el diseño coincide con las expectativas de tiempo de ejecución de OpenClaw.

Cada complemento nativo de OpenClaw debe incluir un archivo openclaw.plugin.json en la raíz del complemento. OpenClaw utiliza este manifiesto para validar la configuración sin ejecutar el código del complemento. Los manifiestos faltantes o no válidos se tratan como errores del complemento y bloquean la validación de la configuración.

Consulte la guía completa del sistema de complementos: Plugins. Para el modelo de capacidades nativo y la guía actual de compatibilidad externa: Capability model.

openclaw.plugin.json son los metadatos que OpenClaw lee antes de cargar su código de complemento. Todo lo que aparece a continuación debe ser lo suficientemente económico para inspeccionar sin iniciar el tiempo de ejecución del complemento.

Úselo para:

  • identidad del complemento, validación de configuración e sugerencias de la interfaz de usuario de configuración
  • metadatos de autenticación, incorporación y configuración (alias, habilitación automática, variables de entorno del proveedor, opciones de autenticación)
  • sugerencias de activación para superficies del plano de control
  • propiedad abreviada de familia de modelos
  • instantáneas estáticas de propiedad de capacidades (contracts)
  • metadatos del ejecutor de QA que el host openclaw qa compartido puede inspeccionar
  • metadatos de configuración específicos del canal fusionados en el catálogo y superficies de validación

No lo utilice para: registrar el comportamiento en tiempo de ejecución, declarar puntos de entrada de código o metadatos de instalación de npm. Esos pertenecen a su código de complemento y package.json.

{
"id": "voice-call",
"configSchema": {
"type": "object",
"additionalProperties": false,
"properties": {}
}
}
{
"id": "openrouter",
"name": "OpenRouter",
"description": "OpenRouter provider plugin",
"version": "1.0.0",
"providers": ["openrouter"],
"modelSupport": {
"modelPrefixes": ["router-"]
},
"modelIdNormalization": {
"providers": {
"openrouter": {
"prefixWhenBare": "openrouter"
}
}
},
"providerEndpoints": [
{
"endpointClass": "openrouter",
"hostSuffixes": ["openrouter.ai"]
}
],
"providerRequest": {
"providers": {
"openrouter": {
"family": "openrouter"
}
}
},
"cliBackends": ["openrouter-cli"],
"syntheticAuthRefs": ["openrouter-cli"],
"setup": {
"providers": [
{
"id": "openrouter",
"envVars": ["OPENROUTER_API_KEY"]
}
]
},
"providerAuthAliases": {
"openrouter-coding": "openrouter"
},
"channelEnvVars": {
"openrouter-chatops": ["OPENROUTER_CHATOPS_TOKEN"]
},
"providerAuthChoices": [
{
"provider": "openrouter",
"method": "api-key",
"choiceId": "openrouter-api-key",
"choiceLabel": "OpenRouter API key",
"groupId": "openrouter",
"groupLabel": "OpenRouter",
"optionKey": "openrouterApiKey",
"cliFlag": "--openrouter-api-key",
"cliOption": "--openrouter-api-key <key>",
"cliDescription": "OpenRouter API key",
"onboardingScopes": ["text-inference"]
}
],
"uiHints": {
"apiKey": {
"label": "API key",
"placeholder": "sk-or-v1-...",
"sensitive": true
}
},
"configSchema": {
"type": "object",
"additionalProperties": false,
"properties": {
"apiKey": {
"type": "string"
}
}
}
}
CampoObligatorioTipoLo que significa
idstringId canónico del complemento. Este es el id utilizado en plugins.entries.<id>.
configSchemaobjectEsquema JSON en línea para la configuración de este complemento.
requiresPluginsNostring[]Ids de complementos que también deben instalarse para que este complemento tenga efecto. Discovery mantiene el complemento cargable pero advierte cuando falta algún complemento requerido.
enabledByDefaultNotrueMarca un complemento agrupado como habilitado de forma predeterminada. Omítalo o establezca cualquier valor que no sea true para dejar el complemento deshabilitado de forma predeterminada.
enabledByDefaultOnPlatformsNostring[]Marca un complemento agrupado como habilitado de forma predeterminada solo en las plataformas de Node.js listadas, por ejemplo ["darwin"]. La configuración explícita tiene prioridad.
legacyPluginIdsNostring[]Ids heredados que se normalizan a este id de complemento canónico.
autoEnableWhenConfiguredProvidersNostring[]Ids de proveedores que deberían habilitar automáticamente este complemento cuando la autenticación, la configuración o las referencias de modelos los mencionen.
kindNo"memory" | "context-engine"Declara un tipo de complemento exclusivo utilizado por plugins.slots.*.
channelsNostring[]Ids de canales propiedad de este complemento. Se utilizan para el descubrimiento y la validación de la configuración.
providersNostring[]Ids de proveedores propiedad de este complemento.
providerCatalogEntryNostringRuta de módulo de catálogo de proveedores ligera, relativa a la raíz del complemento, para metadatos de catálogo de proveedores con ámbito de manifiesto que se pueden cargar sin activar el tiempo de ejecución completo del complemento.
modelSupportNoobjectMetadatos abreviados de familia de modelos propiedad del manifiesto, utilizados para cargar automáticamente el complemento antes del tiempo de ejecución.
modelCatalogNoobjectMetadatos declarativos del catálogo de modelos para proveedores propiedad de este complemento. Este es el contrato del plano de control para listados de solo lectura futuros, incorporación, selectores de modelos, alias y supresión sin cargar el tiempo de ejecución del complemento.
modelPricingNoobjectPolítica de búsqueda de precios externos propiedad del proveedor. Úsela para excluir a los proveedores locales/autoalojados de los catálogos de precios remotos o para asignar referencias de proveedores a IDs de catálogo de OpenRouter/LiteLLM sin codificar los IDs de proveedor en el núcleo.
modelIdNormalizationNoobjectLimpieza de alias/prefijos de ID de modelo propiedad del proveedor que debe ejecutarse antes de que se cargue el tiempo de ejecución del proveedor.
providerEndpointsNoobject[]Metadatos de host/baseUrl del punto de conexión propiedad del manifiesto para las rutas del proveedor que el núcleo debe clasificar antes de que se cargue el tiempo de ejecución del proveedor.
providerRequestNoobjectMetadatos de familia de proveedores y compatibilidad de solicitudes de bajo costo utilizados por la política de solicitud genérica antes de que se cargue el tiempo de ejecución del proveedor.
secretProviderIntegrationsNoRecord<string, object>Ajustes predefinidos de proveedores exec SecretRef declarativos que las superficies de configuración o instalación pueden ofrecer sin codificar integraciones específicas del proveedor en el núcleo.
cliBackendsNostring[]IDs de backend de inferencia de CLI propiedad de este complemento. Se utiliza para la autoactivación al inicio desde referencias de configuración explícitas.
syntheticAuthRefsNostring[]Referencias de proveedor o backend de CLI cuyo gancho de autenticación sintético propiedad del complemento debe sondearse durante el descubrimiento de modelos en frío antes de las cargas de tiempo de ejecución.
nonSecretAuthMarkersNostring[]Valores de clave de API de marcador de posición propiedad del complemento agrupado que representan un estado de credenciales local, OAuth o ambiente no secreto.
commandAliasesNoobject[]Nombres de comandos propiedad de este complemento que deben generar configuración y diagnósticos de CLI conscientes del complemento antes de que se cargue el tiempo de ejecución.
providerAuthEnvVarsNoRecord<string, string[]>Metadatos de entorno de compatibilidad en desuso para la búsqueda de autenticación/estado del proveedor. Prefiera setup.providers[].envVars para complementos nuevos; OpenClaw todavía lee esto durante el período de obsolescencia.
providerAuthAliasesNoRecord<string, string>ID de proveedor que deben reutilizar otro ID de proveedor para la búsqueda de autenticación, por ejemplo, un proveedor de codificación que comparte la clave API del proveedor base y los perfiles de autenticación.
channelEnvVarsNoRecord<string, string[]>Metadatos de entorno de canal económico que OpenClaw puede inspeccionar sin cargar el código del complemento. Use esto para la configuración de canal impulsada por entorno o superficies de autenticación que los asistentes genéricos de inicio/configuración deberían ver.
providerAuthChoicesNoobject[]Metadatos económicos de elección de autenticación para selectores de incorporación, resolución de proveedor preferido y cableado simple de indicadores CLI.
activationNoobjectMetadatos económicos del planificador de activación para la carga activada por inicio, proveedor, comando, canal, ruta y capacidad. Solo metadatos; el tiempo de ejecución del complemento sigue siendo el propietario del comportamiento real.
setupNoobjectDescriptores económicos de configuración/incorporación que las superficies de descubrimiento y configuración pueden inspeccionar sin cargar el tiempo de ejecución del complemento.
qaRunnersNoobject[]Descriptores económicos de ejecutor de QA utilizados por el host openclaw qa compartido antes de que se cargue el tiempo de ejecución del complemento.
contractsNoobjectInstantánea estática de propiedad de capacidades para ganchos de autenticación externos, incrustaciones, voz, transcripción en tiempo real, voz en tiempo real, comprensión de medios, generación de imágenes, generación de música, generación de video, obtención web, búsqueda web y propiedad de herramientas.
mediaUnderstandingProviderMetadataNoRecord<string, object>Valores predeterminados económicos de comprensión de medios para los ID de proveedor declarados en contracts.mediaUnderstandingProviders.
imageGenerationProviderMetadataNoRecord<string, object>Metadatos de autenticación económica para la generación de imágenes para los ids de proveedor declarados en contracts.imageGenerationProviders, incluyendo alias de autenticación propios del proveedor y protecciones de URL base.
videoGenerationProviderMetadataNoRecord<string, object>Metadatos de autenticación económica para la generación de videos para los ids de proveedor declarados en contracts.videoGenerationProviders, incluyendo alias de autenticación propios del proveedor y protecciones de URL base.
musicGenerationProviderMetadataNoRecord<string, object>Metadatos de autenticación económica para la generación de música para los ids de proveedor declarados en contracts.musicGenerationProviders, incluyendo alias de autenticación propios del proveedor y protecciones de URL base.
toolMetadataNoRecord<string, object>Metadatos de disponibilidad económica para las herramientas propiedad del complemento declaradas en contracts.tools. Úselo cuando una herramienta no debe cargar el tiempo de ejecución a menos que existan evidencias de configuración, entorno o autenticación.
channelConfigsNoRecord<string, object>Metadatos de configuración de canal propiedad del manifiesto combinados en las superficies de descubrimiento y validación antes de que se cargue el tiempo de ejecución.
skillsNostring[]Directorios de habilidades (skills) a cargar, relativos a la raíz del complemento.
nameNostringNombre del complemento legible por humanos.
descriptionNostringResumen breve que se muestra en las superficies del complemento.
versionNostringVersión del complemento informativa.
uiHintsNoRecord<string, object>Etiquetas de interfaz de usuario, marcadores de posición e indicaciones de sensibilidad para los campos de configuración.

Referencia de metadatos del proveedor de generación

Sección titulada «Referencia de metadatos del proveedor de generación»

Los campos de metadatos del proveedor de generación describen señales de autenticación estática para los proveedores declarados en la lista contracts.*GenerationProviders coincidente. OpenClaw lee estos campos antes de que se cargue el tiempo de ejecución del proveedor para que las herramientas básicas puedan decidir si un proveedor de generación está disponible sin importar todos los complementos del proveedor.

Use estos campos solo para hechos declarativos económicos. El transporte, las transformaciones de solicitudes, la actualización de tokens, la validación de credenciales y el comportamiento de generación real permanecen en el tiempo de ejecución del complemento.

{
"contracts": {
"imageGenerationProviders": ["example-image"]
},
"imageGenerationProviderMetadata": {
"example-image": {
"aliases": ["example-image-oauth"],
"authProviders": ["example-image"],
"configSignals": [
{
"rootPath": "plugins.entries.example-image.config",
"overlayPath": "image",
"mode": {
"path": "mode",
"default": "local",
"allowed": ["local"]
},
"requiredAny": ["workflow", "workflowPath"],
"required": ["promptNodeId"]
}
],
"authSignals": [
{
"provider": "example-image"
},
{
"provider": "example-image-oauth",
"providerBaseUrl": {
"provider": "example-image",
"defaultBaseUrl": "https://api.example.com/v1",
"allowedBaseUrls": ["https://api.example.com/v1"]
}
}
]
}
}
}

Cada entrada de metadatos admite:

CampoObligatorioTipoLo que significa
aliasesNostring[]Ids de proveedores adicionales que deben contar como alias de autenticación estática para el proveedor de generación.
authProvidersNostring[]Ids de proveedores cuyos perfiles de autenticación configurados deben contar como autenticación para este proveedor de generación.
configSignalsNoobject[]Señales de disponibilidad baratas y solo de configuración para proveedores locales o autohospedados que se pueden configurar sin perfiles de autenticación o variables de entorno.
authSignalsNoobject[]Señales de autenticación explícitas. Cuando están presentes, estas reemplazan el conjunto de señales predeterminado del id del proveedor, aliases y authProviders.
referenceAudioInputsNobooleanSolo para generación de video. Establézcalo en true cuando el proveedor acepta activos de audio de referencia; de lo contrario, video_generate oculta los parámetros de referencia de audio.

Cada entrada configSignals admite:

CampoObligatorioTipoLo que significa
rootPathstringRuta de puntos al objeto de configuración propiedad del complemento para inspeccionar, por ejemplo, plugins.entries.example.config.
overlayPathNostringRuta de puntos dentro de la configuración raíz cuyo objeto debe superponerse al objeto raíz antes de evaluar la señal. Use esto para configuración específica de la capacidad, como image, video o music.
overlayMapPathNostringRuta de puntos dentro de la configuración raíz cuyos valores de objeto deben superponerse cada uno al objeto raíz. Úselo para mapas de cuentas con nombre como accounts, donde cualquier cuenta configurada debe calificar.
requiredNostring[]Rutas de puntos dentro de la configuración efectiva que deben tener valores configurados. Las cadenas no deben estar vacías; los objetos y matrices no deben estar vacíos.
requiredAnyNostring[]Rutas de puntos dentro de la configuración efectiva donde al menos una debe tener un valor configurado.
modeNoobjectGuardián de modo de cadena opcional dentro de la configuración efectiva. Úselo cuando la disponibilidad solo de configuración se aplique a un solo modo.

Cada guardián mode admite:

CampoObligatorioTipoLo que significa
pathNostringRuta de puntos dentro de la configuración efectiva. El valor predeterminado es mode.
defaultNostringValor de modo para usar cuando la configuración omite la ruta.
allowedNostring[]Si está presente, la señal pasa solo cuando el modo efectivo es uno de estos valores.
disallowedNostring[]Si está presente, la señal falla cuando el modo efectivo es uno de estos valores.

Cada entrada authSignals admite:

CampoObligatorioTipoLo que significa
providerstringID de proveedor para verificar en los perfiles de autenticación configurados.
providerBaseUrlNoobjectGuardián opcional que hace que la señal cuente solo cuando el proveedor configurado al que se hace referencia utiliza una URL base permitida. Úselo cuando un alias de autenticación sea válido solo para ciertas API.

Cada protección providerBaseUrl admite:

CampoObligatorioTipoSignificado
providerstringId de configuración del proveedor cuyo baseUrl debe verificarse.
defaultBaseUrlNostringURL base a asumir cuando la configuración del proveedor omite baseUrl.
allowedBaseUrlsstring[]URLs base permitidas para esta señal de autenticación. La señal se ignora cuando la URL base configurada o predeterminada no coincide con uno de estos valores normalizados.

toolMetadata usa las mismas formas configSignals y authSignals que los metadatos del proveedor de generación, indexados por el nombre de la herramienta. contracts.tools declara la propiedad. toolMetadata declara pruebas de disponibilidad baratas para que OpenClaw pueda evitar importar un tiempo de ejecución del complemento solo para que su fábrica de herramientas devuelva null.

{
"setup": {
"providers": [
{
"id": "example",
"envVars": ["EXAMPLE_API_KEY"]
}
]
},
"contracts": {
"tools": ["example_search"]
},
"toolMetadata": {
"example_search": {
"authSignals": [
{
"provider": "example"
}
],
"configSignals": [
{
"rootPath": "plugins.entries.example.config",
"overlayPath": "search",
"required": ["apiKey"]
}
]
}
}
}

Si una herramienta no tiene toolMetadata, OpenClaw preserva el comportamiento existente y carga el complemento propietario cuando el contrato de la herramienta coincide con la política. Para herramientas de ruta crítica cuya fábrica depende de la autorización/configuración, los autores de complementos deben declarar toolMetadata en lugar de hacer que el núcleo importe el tiempo de ejecución para preguntar.

Cada entrada providerAuthChoices describe una opción de incorporación o autenticación. OpenClaw lee esto antes de que se cargue el tiempo de ejecución del proveedor. Las listas de configuración del proveedor usan estas opciones de manifiesto, opciones de configuración derivadas del descriptor y metadatos del catálogo de instalación sin cargar el tiempo de ejecución del proveedor.

CampoObligatorioTipoSignificado
providerstringId del proveedor al que pertenece esta opción.
methodstringId del método de autenticación al que enviar.
choiceIdstringId estable de la opción de autenticación utilizado por los flujos de incorporación y CLI.
choiceLabelNostringEtiqueta orientada al usuario. Si se omite, OpenClaw recurre a choiceId.
choiceHintNostringTexto de ayuda breve para el selector.
assistantPriorityNonumberLos valores más bajos se ordenan antes en los selectores interactivos impulsados por el asistente.
assistantVisibilityNo"visible" | "manual-only"Oculta la elección de los selectores del asistente mientras sigue permitiendo la selección manual de la CLI.
deprecatedChoiceIdsNostring[]Ids de elección heredados que deberían redirigir a los usuarios a esta opción de reemplazo.
groupIdNostringId de grupo opcional para agrupar opciones relacionadas.
groupLabelNostringEtiqueta visible para el usuario para ese grupo.
groupHintNostringTexto de ayuda breve para el grupo.
optionKeyNostringClave de opción interna para flujos de autenticación simples de una sola bandera.
cliFlagNostringNombre de la bandera de CLI, como --openrouter-api-key.
cliOptionNostringForma completa de la opción de CLI, como --openrouter-api-key <key>.
cliDescriptionNostringDescripción utilizada en la ayuda de la CLI.
onboardingScopesNoArray<"text-inference" | "image-generation" | "music-generation">En qué superficies de incorporación debería aparecer esta opción. Si se omite, el valor predeterminado es ["text-inference"].

Use commandAliases cuando un complemento posee un nombre de comando de tiempo de ejecución que los usuarios pueden colocar erróneamente en plugins.allow o intentar ejecutar como un comando raíz de la CLI. OpenClaw utiliza estos metadatos para diagnósticos sin importar el código de tiempo de ejecución del complemento.

{
"commandAliases": [
{
"name": "dreaming",
"kind": "runtime-slash",
"cliCommand": "memory"
}
]
}
CampoObligatorioTipoLo que significa
namestringNombre del comando que pertenece a este complemento.
kindNo"runtime-slash"Marca el alias como un comando de barra de chat en lugar de un comando raíz de la CLI.
cliCommandNostringComando raíz de la CLI relacionado para sugerir para operaciones de la CLI, si existe uno.

Use activation cuando el complemento puede declarar de manera económica qué eventos del plano de control deben incluirlo en un plan de activación/carga.

Este bloque son metadatos del planificador, no una API del ciclo de vida. No registra comportamiento en tiempo de ejecución, no reemplaza register(...) y no promete que el código del complemento ya se haya ejecutado. El planificador de activaciones utiliza estos campos para reducir los complementos candidatos antes de recurrir a los metadatos de propiedad del manifiesto existentes, como providers, channels, commandAliases, setup.providers, contracts.tools y hooks.

Prefiera los metadatos más estrechos que ya describen la propiedad. Use providers, channels, commandAliases, descriptores de configuración o contracts cuando esos campos expresen la relación. Use activation para pistas adicionales del planificador que no pueden ser representadas por esos campos de propiedad. Use cliBackends de nivel superior para alias de tiempo de ejecución de CLI como claude-cli, my-cli o google-gemini-cli; activation.onAgentHarnesses es solo para ids de harness de agente integrado que aún no tienen un campo de propiedad.

Este bloque son solo metadatos. No registra comportamiento en tiempo de ejecución y no reemplaza register(...), setupEntry u otros puntos de entrada del complemento/tiempo de ejecución. Los consumidores actuales lo usan como una pista de reducción antes de una carga más amplia de complementos, por lo que faltar metadatos de activación que no sean de inicio generalmente solo cuesta rendimiento; no debería cambiar la corrección siempre que existan los recursos de propiedad del manifiesto.

Cada complemento debe establecer activation.onStartup intencionalmente. Establézcalo en true solo cuando el complemento debe ejecutarse durante el inicio de Gateway. Establézcalo en false cuando el complemento está inactivo al inicio y debe cargarse solo desde disparadores más estrechos. Omitir onStartup ya no carga implícitamente el complemento al inicio; use metadatos de activación explícitos para inicio, canal, configuración, arnés de agente, memoria u otros disparadores de activación más estrechos.

{
"activation": {
"onStartup": false,
"onProviders": ["openai"],
"onCommands": ["models"],
"onChannels": ["web"],
"onRoutes": ["gateway-webhook"],
"onConfigPaths": ["browser"],
"onCapabilities": ["provider", "tool"]
}
}
CampoObligatorioTipoLo que significa
onStartupNobooleanActivación explícita al inicio de Gateway. Cada complemento debe establecer esto. true importa el complemento durante el inicio; false lo mantiene diferido al inicio a menos que otro disparador coincidente requiera su carga.
onProvidersNostring[]Identificadores de proveedores que deben incluir este complemento en los planes de activación/carga.
onAgentHarnessesNostring[]Identificadores de tiempo de ejecución del arnés de agente integrado que deben incluir este complemento en los planes de activación/carga. Use cliBackends de nivel superior para los alias del backend de CLI.
onCommandsNostring[]Identificadores de comandos que deben incluir este complemento en los planes de activación/carga.
onChannelsNostring[]Identificadores de canales que deben incluir este complemento en los planes de activación/carga.
onRoutesNostring[]Tipos de rutas que deben incluir este complemento en los planes de activación/carga.
onConfigPathsNostring[]Rutas de configuración relativas a la raíz que deben incluir este complemento en los planes de inicio/carga cuando la ruta está presente y no está deshabilitada explícitamente.
onCapabilitiesNoArray<"provider" | "channel" | "tool" | "hook">Sugerencias de capacidades amplias utilizadas por la planificación de activación del plano de control. Se prefieren campos más estrechos cuando sea posible.

Consumidores en vivo actuales:

  • La planificación del inicio de Gateway usa activation.onStartup para la importación explícita al inicio
  • La planificación de la CLI activada por comandos recurre al commandAliases[].cliCommand o commandAliases[].name heredados
  • la planificación del inicio de agent-runtime usa activation.onAgentHarnesses para arness integrados y cliBackends[] de nivel superior para los alias del tiempo de ejecución de CLI
  • la configuración/planificación activada por canales recurre a la propiedad channels[] heredada cuando falta metadatos de activación de canal explícitos
  • la planificación de complementos de inicio usa activation.onConfigPaths para superficies de configuración raíz que no son de canal, como el bloque browser del complemento del navegador incluido
  • la configuración/planificación del tiempo de ejecución activada por proveedores recurre a la propiedad providers[] heredada y a cliBackends[] de nivel superior cuando faltan metadatos de activación de proveedor explícitos

Los diagnósticos del planificador pueden distinguir las sugerencias de activación explícitas del respaldo de propiedad del manifiesto. Por ejemplo, activation-command-hint significa que activation.onCommands coincidió, mientras que manifest-command-alias significa que el planificador utilizó la propiedad commandAliases en su lugar. Estas etiquetas de motivo son para los diagnósticos y pruebas del host; los autores de complementos deben seguir declarando los metadatos que mejor describan la propiedad.

Use qaRunners cuando un complemento contribuye con uno o más transport runners debajo de la raíz compartida openclaw qa. Mantenga estos metadatos baratos y estáticos; el tiempo de ejecución del complemento aún posee el registro real de CLI a través de una superficie runtime-api.ts ligera que exporta qaRunnerCliRegistrations.

{
"qaRunners": [
{
"commandName": "matrix",
"description": "Run the Docker-backed Matrix live QA lane against a disposable homeserver"
}
]
}
CampoRequeridoTipoQué significa
commandNamestringSubcomando montado debajo de openclaw qa, por ejemplo matrix.
descriptionNostringTexto de ayuda de respaldo que se usa cuando el host compartido necesita un comando stub.

Use setup cuando las superficies de configuración y incorporación necesitan metadatos propiedad del complemento económicos antes de que se cargue el tiempo de ejecución.

{
"setup": {
"providers": [
{
"id": "openai",
"authMethods": ["api-key"],
"envVars": ["OPENAI_API_KEY"],
"authEvidence": [
{
"type": "local-file-with-env",
"fileEnvVar": "OPENAI_CREDENTIALS_FILE",
"requiresAllEnv": ["OPENAI_PROJECT"],
"credentialMarker": "openai-local-credentials",
"source": "openai local credentials"
}
]
}
],
"cliBackends": ["openai-cli"],
"configMigrations": ["legacy-openai-auth"],
"requiresRuntime": false
}
}

El nivel superior cliBackends sigue siendo válido y sigue describiendo los backends de inferencia de CLI. setup.cliBackends es la superficie del descriptor específica de la configuración para los flujos de control plano/configuración que deben mantenerse solo como metadatos.

Cuando están presentes, setup.providers y setup.cliBackends son la superficie de búsqueda preferida basada primero en descriptores para el descubrimiento de la configuración. Si el descriptor solo reduce el complemento candidato y la configuración aún necesita enlaces de tiempo de ejecución más ricos en el momento de la configuración, establezca requiresRuntime: true y mantenga setup-api en su lugar como la ruta de ejecución de respaldo.

OpenClaw también incluye setup.providers[].envVars en búsquedas genéricas de autenticación de proveedor y variables de entorno. providerAuthEnvVars sigue siendo compatible a través de un adaptador de compatibilidad durante el período de desaprobación, pero los complementos no empaquetados que aún lo usan reciben un diagnóstico de manifiesto. Los nuevos complementos deben colocar los metadatos de entorno de configuración/estado en setup.providers[].envVars.

OpenClaw también puede derivar opciones simples de configuración desde setup.providers[].authMethods cuando no hay ninguna entrada de configuración disponible, o cuando setup.requiresRuntime: false declara que el tiempo de ejecución de configuración es innecesario. Las entradas explícitas de providerAuthChoices siguen siendo las preferidas para las etiquetas personalizadas, las marcas de CLI, el alcance de incorporación y los metadatos del asistente.

Establezca requiresRuntime: false solo cuando esos descriptores sean suficientes para la superficie de configuración. OpenClaw trata el false explícito como un contrato de solo descriptor y no ejecutará setup-api o openclaw.setupEntry para la búsqueda de configuración. Si un complemento de solo descriptor todavía envía una de esas entradas de tiempo de ejecución de configuración, OpenClaw informa un diagnóstico aditivo y continúa ignorándolo. El requiresRuntime omitido mantiene el comportamiento de respaldo heredado para que los complementos existentes que agregaron descriptores sin la marca no se rompan.

Debido a que la búsqueda de configuración puede ejecutar código setup-api propiedad del complemento, los valores normalizados setup.providers[].id y setup.cliBackends[] deben mantenerse únicos entre los complementos descubiertos. La propiedad ambigua falla (se cierra) en lugar de elegir un ganador del orden de descubrimiento.

Cuando se ejecuta el tiempo de ejecución de configuración (setup runtime), los diagnósticos del registro de configuración informan de una deriva del descriptor si setup-api registra un proveedor o un backend de CLI que los descriptores del manifiesto no declaran, o si un descriptor no tiene un registro en tiempo de ejecución coincidente. Estos diagnósticos son acumulativos y no rechazan los complementos heredados (legacy).

CampoObligatorioTipoQué significa
idstringID del proveedor expuesto durante la configuración o el incorporamiento (onboarding). Mantenga los IDs normalizados únicos a nivel global.
authMethodsNostring[]IDs de método de configuración/autenticación que este proveedor admite sin cargar el tiempo de ejecución completo.
envVarsNostring[]Variables de entorno que las superficies genéricas de configuración/estado pueden verificar antes de que se cargue el tiempo de ejecución del complemento.
authEvidenceNoobject[]Verificaciones locales de evidencia de autenticación económicas para proveedores que pueden autenticarse mediante marcadores no secretos.

authEvidence es para marcadores de credenciales locales propiedad del proveedor que pueden ser verificados sin cargar código de tiempo de ejecución. Estas verificaciones deben mantenerse económicas y locales: sin llamadas a la red, sin lecturas de llaveros o administradores de secretos, sin comandos de shell y sin sondas de API del proveedor.

Entradas de evidencia admitidas:

CampoObligatorioTipoQué significa
typestringActualmente local-file-with-env.
fileEnvVarNostringVariable de entorno que contiene una ruta explícita al archivo de credenciales.
fallbackPathsNostring[]Rutas de archivo de credenciales locales que se verifican cuando fileEnvVar está ausente o vacío. Admite ${HOME} y ${APPDATA}.
requiresAnyEnvNostring[]Al menos una variable de entorno listada debe no estar vacía para que la evidencia sea válida.
requiresAllEnvNostring[]Cada variable de entorno listada debe no estar vacía para que la evidencia sea válida.
credentialMarkerstringMarcador no secreto devuelto cuando la evidencia está presente.
sourceNostringEtiqueta de origen orientada al usuario para la salida de autenticación/estado.
CampoObligatorioTipoSignificado
providersNoobject[]Descriptores de configuración del proveedor expuestos durante la configuración y el incorporamiento.
cliBackendsNostring[]Identificadores de backend en tiempo de configuración utilizados para la búsqueda de configuración basada en descriptores. Mantenga los identificadores normalizados globalmente únicos.
configMigrationsNostring[]Identificadores de migración de configuración propiedad de la superficie de configuración de este complemento.
requiresRuntimeNobooleanSi la configuración aún necesita la ejecución de setup-api después de la búsqueda del descriptor.

uiHints es un mapa de nombres de campos de configuración a pequeñas sugerencias de renderizado.

{
"uiHints": {
"apiKey": {
"label": "API key",
"help": "Used for OpenRouter requests",
"placeholder": "sk-or-v1-...",
"sensitive": true
}
}
}

Cada sugerencia de campo puede incluir:

CampoTipoSignificado
labelstringEtiqueta del campo orientada al usuario.
helpstringTexto de ayuda breve.
tagsstring[]Etiquetas de interfaz de usuario opcionales.
advancedbooleanMarca el campo como avanzado.
sensitivebooleanMarca el campo como secreto o confidencial.
placeholderstringTexto de marcador de posición para entradas de formulario.

Use contracts solo para metadatos de propiedad de capacidades estáticas que OpenClaw puede leer sin importar el tiempo de ejecución del complemento.

{
"contracts": {
"agentToolResultMiddleware": ["openclaw", "codex"],
"externalAuthProviders": ["acme-ai"],
"embeddingProviders": ["openai-compatible"],
"speechProviders": ["openai"],
"realtimeTranscriptionProviders": ["openai"],
"realtimeVoiceProviders": ["openai"],
"memoryEmbeddingProviders": ["local"],
"mediaUnderstandingProviders": ["openai"],
"imageGenerationProviders": ["openai"],
"videoGenerationProviders": ["qwen"],
"webFetchProviders": ["firecrawl"],
"webSearchProviders": ["gemini"],
"migrationProviders": ["hermes"],
"gatewayMethodDispatch": ["authenticated-request"],
"tools": ["firecrawl_search", "firecrawl_scrape"]
}
}

Cada lista es opcional:

CampoTipoSignificado
embeddedExtensionFactoriesstring[]Identificadores de fábrica de extensión del servidor de aplicaciones de Codex, actualmente codex-app-server.
agentToolResultMiddlewarestring[]Identificadores de tiempo de ejecución para los que un complemento empaquetado puede registrar middleware de resultados de herramientas.
externalAuthProvidersstring[]Identificadores de proveedores cuyo gancho de perfil de autenticación externa es propiedad de este complemento.
embeddingProvidersstring[]IDs de proveedores de incrustación generales que posee este complemento para el uso de incrustaciones de vectores reutilizables, incluida la memoria.
speechProvidersstring[]IDs de proveedores de voz que posee este complemento.
realtimeTranscriptionProvidersstring[]IDs de proveedores de transcripción en tiempo real que posee este complemento.
realtimeVoiceProvidersstring[]IDs de proveedores de voz en tiempo real que posee este complemento.
memoryEmbeddingProvidersstring[]IDs de proveedores de incrustación específicos para memoria en desuso que posee este complemento.
mediaUnderstandingProvidersstring[]IDs de proveedores de comprensión de medios que posee este complemento.
transcriptSourceProvidersstring[]IDs de proveedores de fuentes de transcripción que posee este complemento.
imageGenerationProvidersstring[]IDs de proveedores de generación de imágenes que posee este complemento.
videoGenerationProvidersstring[]IDs de proveedores de generación de video que posee este complemento.
webFetchProvidersstring[]IDs de proveedores de recuperación web que posee este complemento.
webSearchProvidersstring[]IDs de proveedores de búsqueda web que posee este complemento.
migrationProvidersstring[]IDs de proveedores de importación que posee este complemento para openclaw migrate.
gatewayMethodDispatchstring[]Derecho reservado para las rutas HTTP autenticadas del complemento que envían métodos de Gateway en proceso.
toolsstring[]Nombres de herramientas de agente que posee este complemento.

contracts.embeddedExtensionFactories se mantiene para fábricas de extensiones solo de servidor de aplicaciones de Codex agrupadas. Las transformaciones de resultados de herramientas agrupadas deben declarar contracts.agentToolResultMiddleware y registrarse con api.registerAgentToolResultMiddleware(...) en su lugar. Los complementos externos no pueden registrar middleware de resultados de herramientas porque la unión puede reescribir la salida de herramientas de alta confianza antes de que el modelo la vea.

Las api.registerTool(...) de tiempo de ejecución deben coincidir con contracts.tools. El descubrimiento de herramientas utiliza esta lista para cargar solo los tiempos de ejecución del complemento que pueden ser propietarios de las herramientas solicitadas.

Los complementos del proveedor que implementan resolveExternalAuthProfiles deben declarar contracts.externalAuthProviders; los ganchos de autenticación externa no declarados se ignoran.

Los proveedores de inserción general deben declarar contracts.embeddingProviders para cada adaptador registrado con api.registerEmbeddingProvider(...). Utilice el contrato general para la generación reutilizable de vectores, incluidos los proveedores consumidos por la búsqueda de memoria. contracts.memoryEmbeddingProviders es una compatibilidad específica de memoria en desuso y permanece solo mientras los proveedores existentes migran a la costura de proveedor de inserción genérico.

contracts.gatewayMethodDispatch actualmente acepta "authenticated-request". Es un control de higiene de API para las rutas HTTP de complementos nativos que envían intencionalmente métodos del plano de control de Gateway en proceso, no un sandbox contra complementos nativos malintencionados. Úselo solo para superficies agrupadas/de operador revisadas exhaustivamente que ya requieren autenticación HTTP de Gateway.

referencia de mediaUnderstandingProviderMetadata

Sección titulada «referencia de mediaUnderstandingProviderMetadata»

Use mediaUnderstandingProviderMetadata cuando un proveedor de comprensión de medios tiene modelos predeterminados, prioridad de reserva de autenticación automática o soporte de documentos nativos que los asistentes centrales genéricos necesitan antes de que se cargue el tiempo de ejecución. Las claves también deben declararse en contracts.mediaUnderstandingProviders.

{
"contracts": {
"mediaUnderstandingProviders": ["example"]
},
"mediaUnderstandingProviderMetadata": {
"example": {
"capabilities": ["image", "audio"],
"defaultModels": {
"image": "example-vision-latest",
"audio": "example-transcribe-latest"
},
"autoPriority": {
"image": 40
},
"nativeDocumentInputs": ["pdf"]
}
}
}

Cada entrada de proveedor puede incluir:

CampoTipoLo que significa
capabilities("image" | "audio" | "video")[]Capacidades de medios expuestas por este proveedor.
defaultModelsRecord<string, string>Valores predeterminados de capacidad a modelo utilizados cuando la configuración no especifica un modelo.
autoPriorityRecord<string, number>Los números más bajos se ordenan antes para la reserva automática de proveedores basada en credenciales.
nativeDocumentInputs"pdf"[]Entradas de documentos nativas compatibles con el proveedor.

Use channelConfigs cuando un complemento de canal necesita metadatos de configuración económicos antes de que se cargue el tiempo de ejecución. La configuración/estado de descubrimiento de solo lectura del canal puede usar estos metadatos directamente para canales externos configurados cuando no hay disponible una entrada de configuración, o cuando setup.requiresRuntime: false declara que la configuración del tiempo de ejecución es innecesaria.

channelConfigs son metadatos del manifiesto del complemento, no una nueva sección de configuración de usuario de nivel superior. Los usuarios todavía configuran las instancias del canal bajo channels.<channel-id>. OpenClaw lee los metadatos del manifiesto para decidir qué complemento posee ese canal configurado antes de que se ejecute el código de tiempo de ejecución del complemento.

Para un complemento de canal, configSchema y channelConfigs describen diferentes rutas:

  • configSchema valida plugins.entries.<plugin-id>.config
  • channelConfigs.<channel-id>.schema valida channels.<channel-id>

Los complementos no empaquetados que declaran channels[] también deben declarar entradas channelConfigs coincidentes. Sin ellas, OpenClaw aún puede cargar el complemento, pero el esquema de configuración de ruta fría, la configuración y las superficies de la interfaz de usuario de Control no pueden conocer la forma de la opción propiedad del canal hasta que se ejecute el tiempo de ejecución del complemento.

channelConfigs.<channel-id>.commands.nativeCommandsAutoEnabled y nativeSkillsAutoEnabled pueden declarar valores predeterminados estáticos de auto para verificaciones de configuración de comandos que se ejecutan antes de que se cargue el tiempo de ejecución del canal. Los canales empaquetados también pueden publicar los mismos valores predeterminados a través de package.json#openclaw.channel.commands junto con sus otros metadatos del catálogo de canales propiedad del paquete.

{
"channelConfigs": {
"matrix": {
"schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"homeserverUrl": { "type": "string" }
}
},
"uiHints": {
"homeserverUrl": {
"label": "Homeserver URL",
"placeholder": "https://matrix.example.com"
}
},
"label": "Matrix",
"description": "Matrix homeserver connection",
"commands": {
"nativeCommandsAutoEnabled": true,
"nativeSkillsAutoEnabled": true
},
"preferOver": ["matrix-legacy"]
}
}
}

Cada entrada de canal puede incluir:

CampoTipoSignificado
schemaobjectEsquema JSON para channels.<id>. Obligatorio para cada entrada de configuración de canal declarada.
uiHintsRecord<string, object>Etiquetas/marcadores de posición/sugerencias sensibles de IU opcionales para esa sección de configuración de canal.
labelstringEtiqueta del canal fusionada en las superficies del selector e inspección cuando los metadatos del tiempo de ejecución no están listos.
descriptionstringDescripción breve del canal para las superficies de inspección y catálogo.
commandsobjectValores predeterminados automáticos estáticos para comandos nativos y habilidades nativas para verificaciones de configuración previas a la ejecución.
preferOverstring[]Identificadores de complementos heredados o de menor prioridad que este canal debe superar en las superficies de selección.

Use preferOver cuando su complemento sea el propietario preferido para un id de canal que otro complemento también puede proporcionar. Los casos comunes son un id de complemento renombrado, un complemento independiente que reemplaza a un complemento empaquetado, o un fork mantenido que mantiene el mismo id de canal para la compatibilidad de configuración.

{
"id": "acme-chat",
"channels": ["chat"],
"channelConfigs": {
"chat": {
"schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"webhookUrl": { "type": "string" }
}
},
"preferOver": ["chat"]
}
}
}

Cuando se configura channels.chat, OpenClaw considera tanto el id del canal como el id del complemento preferido. Si el complemento de menor prioridad solo se seleccionó porque está empaquetado o habilitado por defecto, OpenClaw lo deshabilita en la configuración de ejecución efectiva para que un complemento sea el propietario del canal y sus herramientas. La selección explícita del usuario gana: si el usuario habilita explícitamente ambos complementos, OpenClaw preserva esa elección e informa diagnósticos de canal/herramienta duplicados en lugar de cambiar silenciosamente el conjunto de complementos solicitado.

Mantenga preferOver limitado a ids de complementos que realmente puedan proporcionar el mismo canal. No es un campo de prioridad general y no cambia las claves de configuración de usuario.

Use modelSupport cuando OpenClaw deba inferir su complemento de proveedor desde ids de modelo abreviados como gpt-5.5 o claude-sonnet-4.6 antes de que se cargue el tiempo de ejecución del complemento.

{
"modelSupport": {
"modelPrefixes": ["gpt-", "o1", "o3", "o4"],
"modelPatterns": ["^computer-use-preview"]
}
}

OpenClaw aplica esta precedencia:

  • las referencias provider/model explícitas usan los metadatos del manifiesto providers propietario
  • modelPatterns ganan a modelPrefixes
  • si un complemento no empaquetado y un complemento empaquetado coinciden, el complemento no empaquetado gana
  • la ambigüedad restante se ignora hasta que el usuario o la configuración especifiquen un proveedor

Campos:

CampoTipoQué significa
modelPrefixesstring[]Prefijos coincidentes con startsWith contra ids de modelo abreviados.
modelPatternsstring[]Fuentes de expresiones regulares que coinciden con identificadores de modelos abreviados después de la eliminación del sufijo del perfil.

Las entradas modelPatterns se compilan a través de compileSafeRegex, que rechaza los patrones que contengan repeticiones anidadas (por ejemplo (a+)+$). Los patrones que no pasan la verificación de seguridad se omiten silenciosamente, igual que las expresiones regulares sintácticamente inválidas. Mantenga los patrones simples y evite cuantificadores anidados.

Use modelCatalog cuando OpenClaw deba conocer los metadatos del modelo del proveedor antes de cargar el tiempo de ejecución del complemento. Esta es la fuente propiedad del manifiesto para filas de catálogo fijas, alias de proveedor, reglas de supresión y modo de descubrimiento. La actualización en tiempo de ejecución aún pertenece al código de tiempo de ejecución del proveedor, pero el manifiesto le indica al núcleo cuándo se requiere el tiempo de ejecución.

{
"providers": ["openai"],
"modelCatalog": {
"providers": {
"openai": {
"baseUrl": "https://api.openai.com/v1",
"api": "openai-responses",
"models": [
{
"id": "gpt-5.4",
"name": "GPT-5.4",
"input": ["text", "image"],
"reasoning": true,
"contextWindow": 256000,
"maxTokens": 128000,
"cost": {
"input": 1.25,
"output": 10,
"cacheRead": 0.125
},
"status": "available",
"tags": ["default"]
}
]
}
},
"aliases": {
"azure-openai-responses": {
"provider": "openai",
"api": "azure-openai-responses"
}
},
"suppressions": [
{
"provider": "azure-openai-responses",
"model": "gpt-5.3-codex-spark",
"reason": "not available on Azure OpenAI Responses"
}
],
"discovery": {
"openai": "static"
}
}
}

Campos de nivel superior:

CampoTipoQué significa
providersRecord<string, object>Filas de catálogo para identificadores de proveedor propiedad de este complemento. Las claves también deben aparecer en el nivel superior providers.
aliasesRecord<string, object>Alias de proveedor que deben resolverse en un proveedor propiedad para la planificación de catálogo o supresión.
suppressionsobject[]Filas de modelo de otra fuente que este complemento suprime por una razón específica del proveedor.
discoveryRecord<string, "static" | "refreshable" | "runtime">Si el catálogo del proveedor se puede leer desde los metadatos del manifiesto, actualizar en caché o requiere tiempo de ejecución.
runtimeAugmentbooleanEstablézcalo en true solo cuando el tiempo de ejecución del proveedor deba agregar filas de catálogo después de la planificación del manifiesto/configuración.

aliases participa en la búsqueda de propiedad del proveedor para la planificación del catálogo de modelos. Los objetivos de alias deben ser proveedores de nivel superior propiedad del mismo complemento. Cuando una lista filtrada por proveedor usa un alias, OpenClaw puede leer el manifiesto propietario y aplicar anulaciones de API/URL base de alias sin cargar el tiempo de ejecución del proveedor. Los alias no expanden las listaciones de catálogo sin filtrar; las listas amplias emiten solo las filas del proveedor canónico propietario.

suppressions reemplaza el antiguo gancho de tiempo de ejecución del proveedor suppressBuiltInModel. Las entradas de supresión se respetan solo cuando el proveedor es propiedad del complemento o declarado como una clave modelCatalog.aliases que apunta a un proveedor propio. Los ganchos de supresión en tiempo de ejecución ya no se llaman durante la resolución del modelo.

Campos del proveedor:

CampoTipoQué significa
baseUrlstringURL base predeterminada opcional para los modelos en este catálogo de proveedores.
apiModelApiAdaptador de API predeterminado opcional para los modelos en este catálogo de proveedores.
headersRecord<string, string>Encabezados estáticos opcionales que aplican a este catálogo de proveedores.
modelsobject[]Filas de modelo obligatorias. Se ignoran las filas sin un id.

Campos del modelo:

CampoTipoQué significa
idstringID de modelo local del proveedor, sin el prefijo provider/.
namestringNombre para mostrar opcional.
apiModelApiInvalidación de API opcional por modelo.
baseUrlstringInvalidación de URL base opcional por modelo.
headersRecord<string, string>Encabezados estáticos opcionales por modelo.
inputArray<"text" | "image" | "document" | "audio" | "video">Modalidades que acepta el modelo.
reasoningbooleanSi el modelo expone comportamiento de razonamiento.
contextWindownumberVentana de contexto nativa del proveedor.
contextTokensnumberLímite efectivo opcional de contexto en tiempo de ejecución cuando difiere de contextWindow.
maxTokensnumberTokens máximos de salida cuando se conocen.
costobjectPrecios opcionales en USD por millón de tokens, incluyendo tieredPricing opcional.
compatobjectMarcas de compatibilidad opcionales que coinciden con la compatibilidad de configuración del modelo de OpenClaw.
status"available" | "preview" | "deprecated" | "disabled"Estado de la lista. Suprimir solo cuando la fila no debe aparecer en absoluto.
statusReasonstringRazón opcional que se muestra con el estado no disponible.
replacesstring[]Identificadores de modelos locales del proveedor anteriores que este modelo reemplaza.
replacedBystringIdentificador de modelo local del proveedor de reemplazo para filas obsoletas.
tagsstring[]Etiquetas estables utilizadas por selectores y filtros.

Campos de supresión:

CampoTipoLo que significa
providerstringIdentificador del proveedor para la fila ascendente que se va a suprimir. Debe ser propiedad de este complemento o declararse como un alias propio.
modelstringIdentificador de modelo local del proveedor para suprimir.
reasonstringMensaje opcional que se muestra cuando se solicita directamente la fila suprimida.
when.baseUrlHostsstring[]Lista opcional de hosts de URL base de proveedor efectivos requeridos antes de que se aplique la supresión.
when.providerConfigApiInstring[]Lista opcional de valores api de configuración del proveedor exactos requeridos antes de que se aplique la supresión.

No pongas datos solo de tiempo de ejecución en modelCatalog. Usa static solo cuando las filas del manifiesto están lo suficientemente completas para que las listas filtradas por proveedor y las superficies del selector puedan omitir el descubrimiento de registro/tiempo de ejecución. Usa refreshable cuando las filas del manifiesto son semillas o complementos listables útiles, pero una actualización/caché puede agregar más filas más adelante; las filas actualizables no son autoritarias por sí mismas. Usa runtime cuando OpenClaw debe cargar el tiempo de ejecución del proveedor para conocer la lista.

Usa modelIdNormalization para una limpieza de ID de modelo propiedad del proveedor que sea barata y que deba ocurrir antes de que se cargue el tiempo de ejecución del proveedor. Esto mantiene alias como nombres cortos de modelo, ID heredados locales del proveedor y reglas de prefijo de proxy en el manifiesto del complemento propietario en lugar de en las tablas centrales de selección de modelos.

{
"providers": ["anthropic", "openrouter"],
"modelIdNormalization": {
"providers": {
"anthropic": {
"aliases": {
"sonnet-4.6": "claude-sonnet-4-6"
}
},
"openrouter": {
"prefixWhenBare": "openrouter"
}
}
}
}

Campos del proveedor:

CampoTipoLo que significa
aliasesRecord<string,string>Alias exactos de ID de modelo que no distinguen mayúsculas y minúsculas. Los valores se devuelven tal como están escritos.
stripPrefixesstring[]Prefijos para eliminar antes de la búsqueda de alias, útiles para la duplicación heredada de proveedor/modelo.
prefixWhenBarestringPrefijo para agregar cuando el ID de modelo normalizado aún no contiene /.
prefixWhenBareAfterAliasStartsWithobject[]Reglas de prefijo de ID desnudo condicionales después de la búsqueda de alias, claveadas por modelPrefix y prefix.

Usa providerEndpoints para la clasificación de puntos finales que la política de solicitud genérica debe conocer antes de que se cargue el tiempo de ejecución del proveedor. El núcleo sigue siendo dueño del significado de cada endpointClass; los manifiestos de los complementos son dueños de los metadatos del host y la URL base.

Campos de punto final:

CampoTipoLo que significa
endpointClassstringClase de punto final central conocida, como openrouter, moonshot-native o google-vertex.
hostsstring[]Nombres de host exactos que se asignan a la clase de punto final.
hostSuffixesstring[]Sufijos de host que se asignan a la clase de extremo. Prefije con . para coincidir solo con sufijos de dominio.
baseUrlsstring[]URLs base HTTP(S) normalizadas exactas que se asignan a la clase de extremo.
googleVertexRegionstringRegión estática de Google Vertex para hosts globales exactos.
googleVertexRegionHostSuffixstringSufijo que se eliminará de los hosts coincidentes para exponer el prefijo de región de Google Vertex.

Use providerRequest para metadatos económicos de compatibilidad de solicitudes que la política de solicitud genérica necesita sin cargar el tiempo de ejecución del proveedor. Mantenga la reescritura de cargas específica del comportamiento en los enlaces del tiempo de ejecución del proveedor o en los ayudantes compartidos de la familia de proveedores.

{
"providers": ["vllm"],
"providerRequest": {
"providers": {
"vllm": {
"family": "vllm",
"openAICompletions": {
"supportsStreamingUsage": true
}
}
}
}
}

Campos del proveedor:

CampoTipoQué significa
familystringEtiqueta de familia de proveedores utilizada por decisiones genéricas de compatibilidad de solicitudes y diagnósticos.
compatibilityFamily"moonshot"Depósito de compatibilidad opcional de la familia de proveedores para ayudantes de solicitudes compartidos.
openAICompletionsobjectMarcadores de solicitud de finalizaciones compatibles con OpenAI, actualmente supportsStreamingUsage.

Use secretProviderIntegrations cuando un complemento pueda publicar un proveedor de ejecución SecretRef reutilizable preestablecido. OpenClaw lee estos metadatos antes de que se cargue el tiempo de ejecución del complemento, almacena la propiedad del complemento en secrets.providers.<alias>.pluginIntegration y deja la resolución real de secretos al tiempo de ejecución de SecretRef. Los preajustes se exponen solo para complementos empaquetados y complementos instalados descubiertos desde las raíces de instalación administradas de complementos, como instalaciones de git y ClawHub.

{
"secretProviderIntegrations": {
"secret-store": {
"providerAlias": "team-secrets",
"displayName": "Team secrets",
"source": "exec",
"command": "${node}",
"args": ["./bin/resolve-secrets.mjs"]
}
}
}

La clave del mapa es el id de integración. Si providerAlias se omite, OpenClaw usa el id de integración como el alias del proveedor SecretRef. Los alias de proveedores deben coincidir con el patrón normal de alias de proveedor de SecretRef, por ejemplo team-secrets o onepassword-work.

Cuando un operador selecciona el preajuste, OpenClaw escribe una referencia de proveedor como:

{
"secrets": {
"providers": {
"team-secrets": {
"source": "exec",
"pluginIntegration": {
"pluginId": "acme-secrets",
"integrationId": "secret-store"
}
}
}
}
}

Al iniciar/recargar, OpenClaw resuelve ese proveedor cargando los metadatos del manifiesto del complemento actual, verificando que el complemento propietario esté instalado y activo, y materializando el comando exec desde el manifiesto. Deshabilitar o eliminar el complemento revoca el proveedor para los SecretRefs activos. Los operadores que deseen una configuración exec independiente aún pueden escribir proveedores manuales command/args directamente.

Actualmente solo se admiten los preajustes source: "exec". command debe ser ${node}, y args[0] debe ser un script de resolución relativo a la raíz del complemento ./. OpenClaw lo materializa al iniciar/recargar con el ejecutable Node actual y la ruta absoluta del script dentro del complemento. Las opciones de Node como --require, --import, --loader, --env-file, --eval y --print no forman parte del contrato del preajuste del manifiesto. Los operadores que necesiten comandos que no sean de Node pueden configurar proveedores exec manuales independientes directamente.

OpenClaw deriva trustedDirs para los preajustes del manifiesto desde la raíz del complemento y, para los preajustes ${node}, el directorio del ejecutable Node actual. Los trustedDirs creados en el manifiesto se ignoran. Otras opciones de proveedor exec como timeoutMs, maxOutputBytes, jsonOnly, env, passEnv y allowInsecurePath se pasan a la configuración normal del proveedor exec de SecretRef.

Use modelPricing cuando un proveedor necesite un comportamiento de precios del plano de control antes de que se cargue el tiempo de ejecución. La caché de precios de Gateway lee estos metadatos sin importar el código de tiempo de ejecución del proveedor.

{
"providers": ["ollama", "openrouter"],
"modelPricing": {
"providers": {
"ollama": {
"external": false
},
"openrouter": {
"openRouter": {
"passthroughProviderModel": true
},
"liteLLM": false
}
}
}
}

Campos del proveedor:

CampoTipoSignificado
externalbooleanEstablezca false para proveedores locales/autohospedados que nunca deben obtener precios de OpenRouter o LiteLLM.
openRouterfalse | objectAsignación de búsqueda de precios de OpenRouter. false deshabilita la búsqueda de OpenRouter para este proveedor.
liteLLMfalse | objectAsignación de búsqueda de precios de LiteLLM. false deshabilita la búsqueda de LiteLLM para este proveedor.

Campos de origen:

CampoTipoQué significa
providerstringID de proveedor de catálogo externo cuando difiere del ID de proveedor de OpenClaw, por ejemplo z-ai para un proveedor zai.
passthroughProviderModelbooleanTratar los IDs de modelo que contienen barras como referencias anidadas de proveedor/modelo, útil para proveedores proxy como OpenRouter.
modelIdTransforms"version-dots"[]Variantes adicionales de ID de modelo de catálogo externo. version-dots intenta IDs de versión con puntos como claude-opus-4.6.

El Índice de proveedores de OpenClaw es metadatos de vista previa propiedad de OpenClaw para proveedores cuyos complementos aún pueden no estar instalados. No es parte de un manifiesto de complemento. Los manifiestos de complementos siguen siendo la autoridad del complemento instalado. El Índice de proveedores es el contrato de reserva interno que consumirán las superficies futuras del selector de modelos de proveedor instalable y preinstalación cuando no se haya instalado un complemento de proveedor.

Orden de autoridad del catálogo:

  1. Configuración de usuario.
  2. Manifiesto de complemento instalado modelCatalog.
  3. Caché del catálogo de modelos de una actualización explícita.
  4. Filas de vista previa del Índice de proveedores de OpenClaw.

El Índice de Proveedores no debe contener secretos, estado habilitado, ganchos de tiempo de ejecución o datos de modelo en vivo específicos de la cuenta. Sus catálogos de vista previa utilizan la misma modelCatalog forma de fila de proveedor que los manifiestos de complementos, pero deben mantenerse limitados a metadatos de visualización estables a menos que los campos del adaptador de tiempo de ejecución como api, baseUrl, precios o indicadores de compatibilidad se mantengan intencionalmente alineados con el manifiesto del complemento instalado. Los proveedores con descubrimiento /models en vivo deben escribir filas actualizadas a través de la ruta de caché explícita del catálogo de modelos en lugar de realizar llamadas normales de listado o incorporación a las API del proveedor.

Las entradas del Índice de Proveedores también pueden llevar metadatos de complementos instalables para proveedores cuyo complemento se ha movido fuera del núcleo o aún no está instalado. Estos metadatos reflejan el patrón del catálogo de canales: el nombre del paquete, la especificación de instalación de npm, la integridad esperada y las etiquetas económicas de elección de autenticación son suficientes para mostrar una opción de configuración instalable. Una vez que se instala el complemento, su manifiuto prevalece y se ignora la entrada del Índice de Proveedores para ese proveedor.

Las claves de capacidad de nivel superior heredadas están obsoletas. Use openclaw doctor --fix para mover speechProviders, realtimeTranscriptionProviders, realtimeVoiceProviders, mediaUnderstandingProviders, imageGenerationProviders, videoGenerationProviders, webFetchProviders y webSearchProviders bajo contracts; la carga normal del manifiesto ya no trata esos campos de nivel superior como propiedad de la capacidad.

Los dos archivos cumplen funciones diferentes:

ArchivoÚselo para
openclaw.plugin.jsonDescubrimiento, validación de configuración, metadatos de elección de autenticación e indicadores de interfaz de usuario que deben existir antes de que se ejecute el código del complemento
package.jsonmetadatos de npm, instalación de dependencias y el bloque openclaw utilizado para puntos de entrada, restricciones de instalación, configuración o metadatos del catálogo

Si no está seguro de dónde pertenece un metadato, use esta regla:

  • si OpenClaw debe conocerlo antes de cargar el código del complemento, colóquelo en openclaw.plugin.json
  • si se trata del empaquetado, los archivos de entrada o el comportamiento de npm install, póngalo en package.json

campos de package. que afectan el descubrimiento

Sección titulada «campos de package. que afectan el descubrimiento»

Algunos metadatos de complementos previos a la ejecución se encuentran intencionalmente en package.json bajo el bloque openclaw en lugar de openclaw.plugin.json. openclaw.bundle y openclaw.bundle.json no son contratos de complementos de OpenClaw; los complementos nativos deben usar openclaw.plugin.json más los campos admitidos de package.json#openclaw a continuación.

Ejemplos importantes:

CampoLo que significa
openclaw.extensionsDeclara los puntos de entrada de complementos nativos. Debe permanecer dentro del directorio del paquete del complemento.
openclaw.runtimeExtensionsDeclara los puntos de entrada de tiempo de ejecución de JavaScript construidos para paquetes instalados. Debe permanecer dentro del directorio del paquete del complemento.
openclaw.setupEntryPunto de entrada ligero solo de configuración utilizado durante la incorporación, el inicio diferido del canal y el estado del canal de solo lectura/descubrimiento de SecretRef. Debe permanecer dentro del directorio del paquete del complemento.
openclaw.runtimeSetupEntryDeclara el punto de entrada de configuración de JavaScript construido para paquetes instalados. Requiere setupEntry, debe existir y debe permanecer dentro del directorio del paquete del complemento.
openclaw.channelMetadatos de catálogo de canal económicos como etiquetas, rutas de documentos, alias y texto de selección.
openclaw.channel.commandsMetadatos predeterminados automáticos de comandos nativos y habilidades nativas estáticas utilizados por las superficies de configuración, auditoría y lista de comandos antes de que se cargue el tiempo de ejecución del canal.
openclaw.channel.configuredStateMetadatos del verificador de estado configurado ligero que puede responder “¿ya existe la configuración solo de entorno?” sin cargar el tiempo de ejecución completo del canal.
openclaw.channel.persistedAuthStateMetadatos del verificador de autenticación persistente ligero que puede responder “¿ya hay algo iniciado sesión?” sin cargar el tiempo de ejecución completo del canal.
openclaw.install.clawhubSpec / openclaw.install.npmSpec / openclaw.install.localPathSugerencias de instalación/actualización para complementos empaquetados y publicados externamente.
openclaw.install.defaultChoiceRuta de instalación preferida cuando hay varias fuentes de instalación disponibles.
openclaw.install.minHostVersionVersión mínima compatible del host OpenClaw, usando un suelo semver como >=2026.3.22 o >=2026.5.1-beta.1.
openclaw.compat.pluginApiRango mínimo de la API de complementos de OpenClaw requerido por este paquete, usando un suelo semver como >=2026.5.27.
openclaw.install.expectedIntegrityCadena de integridad dist de npm esperada como sha512-...; los flujos de instalación y actualización verifican el artefacto recuperado contra ella.
openclaw.install.allowInvalidConfigRecoveryPermite una ruta de recuperación de reinstalación estrecha de complementos empaquetados cuando la configuración no es válida.
openclaw.startup.deferConfiguredChannelFullLoadUntilAfterListenPermite que las superficies del canal de tiempo de ejecución de configuración se carguen antes de escuchar, luego difiere el complemento de canal completamente configurado hasta la activación posterior a la escucha.

Los metadatos del manifiesto deciden qué opciones de proveedor/canal/configuración aparecen en la incorporación antes de que se cargue el tiempo de ejecución. package.json#openclaw.install indica a la incorporación cómo obtener o habilitar ese complemento cuando el usuario elige una de esas opciones. No mueva las sugerencias de instalación a openclaw.plugin.json.

openclaw.install.minHostVersion se hace cumplir durante la instalación y la carga del registro de manifiestos para fuentes de complementos no empaquetados. Los valores no válidos se rechazan; los valores válidos pero más nuevos omiten los complementos externos en hosts más antiguos. Se asume que los complementos de fuentes empaquetados están coversionados con la revisión del host.

openclaw.compat.pluginApi se hace cumplir durante la instalación del paquete para fuentes de complementos no empaquetados. Úselo para el suelo de la API del SDK/tiempo de ejecución del complemento de OpenClaw contra el cual se construyó el paquete. Puede ser más estricto que minHostVersion cuando un paquete de complemento necesita una API más nueva pero aún mantiene una sugerencia de instalación más baja para otros flujos. La sincronización de la versión oficial de OpenClaw aumenta los suelos de la API del complemento oficial existentes a la versión de lanzamiento de OpenClaw de forma predeterminada, pero los lanzamientos solo de complementos pueden mantener un suelo más bajo cuando el paquete admite intencionalmente hosts más antiguos. No use la versión del paquete por sí sola como contrato de compatibilidad. peerDependencies.openclaw sigue siendo metadatos del paquete npm; OpenClaw usa el contrato openclaw.compat.pluginApi para las decisiones de compatibilidad de instalación.

Los metadatos oficiales de instalación bajo deben usar clawhubSpec cuando el complemento está publicado en ClawHub; el proceso de incorporación lo trata como la fuente remota preferida y registra los datos del artefacto de ClawHub después de la instalación. npmSpec sigue siendo la alternativa de compatibilidad para los paquetes que aún no se han movido a ClawHub.

La fijación de versión exacta de npm ya reside en npmSpec, por ejemplo "npmSpec": "@wecom/[email protected]". Las entradas oficiales de catálogos externos deben emparejar especificaciones exactas con expectedIntegrity para que los flujos de actualización fallen cerrado si el artefacto de npm obtenido ya no coincide con la versión fijada. El proceso de incorporación interactivo aún ofrece especificaciones de npm de registros confiables, incluyendo nombres de paquetes simples y dist-tags, por compatibilidad. Los diagnósticos del catálogo pueden distinguir fuentes exactas, flotantes, fijadas por integridad, con integridad faltante, discordancia de nombre de paquete y de elección predeterminada no válida. También advierten cuando expectedIntegrity está presente pero no hay una fuente válida de npm que pueda fijar. Cuando expectedIntegrity está presente, los flujos de instalación/actualización lo hacen cumplir; cuando se omite, la resolución del registro se registra sin un anclaje de integridad.

Los complementos de canal deben proporcionar openclaw.setupEntry cuando el estado, la lista de canales, o los escaneos de SecretRef necesitan identificar cuentas configuradas sin cargar el tiempo de ejecución completo. La entrada de configuración debe exponer metadatos del canal además de adaptadores de configuración, estado y secretos seguros para la configuración; mantenga los clientes de red, los oyentes de puerta de enlace y los tiempos de ejecución de transporte en el punto de entrada principal de la extensión.

Los campos de punto de entrada de tiempo de ejecución no anulan las comprobaciones de límites del paquete para los campos de punto de entrada de origen. Por ejemplo, openclaw.runtimeExtensions no puede hacer que una ruta que escapa openclaw.extensions se pueda cargar.

openclaw.install.allowInvalidConfigRecovery es intencionalmente limitado. No hace que configuraciones rotas arbitrarias sean instalables. Hoy solo permite que los flujos de instalación se recuperen de fallos específicos de actualización de complementos empaquetados obsoletos, como una ruta de complemento empaquetado faltante o una entrada channels.<id> obsoleta para ese mismo complemento empaquetado. Errores de configuración no relacionados todavía bloquean la instalación y envían a los operadores a openclaw doctor --fix.

openclaw.channel.persistedAuthState son metadatos del paquete para un módulo de verificación pequeño:

{
"openclaw": {
"channel": {
"id": "whatsapp",
"persistedAuthState": {
"specifier": "./auth-presence",
"exportName": "hasAnyWhatsAppAuth"
}
}
}
}

Úselo cuando los flujos de configuración, doctor, estado o presencia de solo lectura necesiten una sonda de autenticación sí/no económica antes de que se cargue el complemento del canal completo. El estado de autenticación persistente no es el estado del canal configurado: no use estos metadatos para habilitar automáticamente los complementos, reparar dependencias en tiempo de ejecución o decidir si se debe cargar un tiempo de ejecución del canal. La exportación de destino debe ser una función pequeña que solo lea el estado persistente; no la enrute a través del barrel del tiempo de ejecución del canal completo.

openclaw.channel.configuredState sigue la misma forma para verificaciones económicas configuradas solo por entorno:

{
"openclaw": {
"channel": {
"id": "telegram",
"configuredState": {
"specifier": "./configured-state",
"exportName": "hasTelegramConfiguredState"
}
}
}
}

Úselo cuando un canal pueda responder el estado configurado desde el entorno u otras entradas pequeñas que no sean de tiempo de ejecución. Si la verificación necesita una resolución completa de la configuración o el tiempo de ejecución real del canal, mantenga esa lógica en el enlace config.hasConfiguredState del complemento en su lugar.

Precedencia de descubrimiento (ids de complemento duplicados)

Sección titulada «Precedencia de descubrimiento (ids de complemento duplicados)»

OpenClaw descubre complementos desde varias raíces. Para ver el orden de escaneo del sistema de archivos sin procesar, consulte Orden de escaneo de complementos. Si dos descubrimientos comparten el mismo id, solo se mantiene el manifiesto de mayor precedencia; los duplicados de menor precedencia se descartan en lugar de cargarse junto con él.

Precedencia, de mayor a menor:

  1. Seleccionado por configuración — una ruta fijada explícitamente en plugins.entries.<id>
  2. Empaquetado — complementos enviados con OpenClaw
  3. Instalación global — complementos instalados en la raíz global de complementos de OpenClaw
  4. Espacio de trabajo — complementos descubiertos en relación con el espacio de trabajo actual

Implicaciones:

  • Una copia bifurcada o obsoleta de un complemento empaquetado que se encuentre en el espacio de trabajo no ocultará la compilación empaquetada.
  • Para anular realmente un complemento empaquetado con uno local, fíjelo mediante plugins.entries.<id> para que gane por precedencia en lugar de confiar en el descubrimiento del espacio de trabajo.
  • Las eliminaciones de duplicados se registran para que Doctor y los diagnósticos de inicio puedan señalar la copia descartada.
  • Las anulaciones de duplicados seleccionados por configuración se formulan como anulaciones explícitas en los diagnósticos, pero aún advierten para que las bifurcaciones obsoletas y las sombras accidentales permanezcan visibles.
  • Cada complemento debe incluir un esquema JSON, incluso si no acepta configuración.
  • Se acepta un esquema vacío (por ejemplo, { "type": "object", "additionalProperties": false }).
  • Los esquemas se validan en el momento de lectura/escritura de la configuración, no en tiempo de ejecución.
  • Al extender o bifurcar un plugin empaquetado con nuevas claves de configuración, actualice el openclaw.plugin.json configSchema de ese plugin al mismo tiempo. Los esquemas de los plugins empaquetados son estrictos, por lo que agregar plugins.entries.<id>.config.myNewKey en la configuración del usuario sin agregar myNewKey al configSchema.properties se rechazará antes de que se cargue el tiempo de ejecución del plugin.

Ejemplo de extensión de esquema:

{
"configSchema": {
"type": "object",
"additionalProperties": false,
"properties": {
"myNewKey": {
"type": "string"
}
}
}
}
  • Las claves channels.* desconocidas son errores, a menos que el id del canal sea declarado por un manifiesto de plugin.
  • plugins.entries.<id>, plugins.allow, plugins.deny y plugins.slots.* deben hacer referencia a ids de plugins detectables. Los ids desconocidos son errores.
  • Si un plugin está instalado pero tiene un manifiesto o esquema roto o faltante, la validación falla y Doctor informa el error del plugin.
  • Si existe la configuración del plugin pero el plugin está deshabilitado, la configuración se mantiene y se muestra una advertencia en Doctor + registros.

Consulte Referencia de configuración para ver el esquema completo de plugins.*.

  • El manifiesto es obligatorio para los plugins nativos de OpenClaw, incluidas las cargas del sistema de archivos local. El tiempo de ejecución todavía carga el módulo del plugin por separado; el manifiesto es solo para descubrimiento y validación.
  • Los manifiestos nativos se analizan con JSON5, por lo que se aceptan comentarios, comas finales y claves sin comillas siempre que el valor final siga siendo un objeto.
  • El cargador de manifiestos solo lee los campos de manifiesto documentados. Evite las claves personalizadas de nivel superior.
  • channels, providers, cliBackends y skills se pueden omitir cuando un plugin no los necesita.
  • providerCatalogEntry debe permanecer ligero y no debe importar código de tiempo de ejecución amplio; úselo para metadatos de catálogo de proveedores estáticos o descriptores de descubrimiento estrechos, no para ejecución en el momento de la solicitud.
  • Los tipos exclusivos de complementos se seleccionan a través de plugins.slots.*: kind: "memory" mediante plugins.slots.memory, kind: "context-engine" mediante plugins.slots.contextEngine (por defecto legacy).
  • Declara el tipo exclusivo de complemento en este manifiesto. La entrada de tiempo de ejecución OpenClawPluginDefinition.kind está obsoleta y permanece solo como una alternativa de compatibilidad para complementos antiguos.
  • Los metadatos de variables de entorno (setup.providers[].envVars, providerAuthEnvVars obsoleto y channelEnvVars) son solo declarativos. El estado, la auditoría, la validación de entrega de cron y otras superficies de solo lectura siguen aplicando la política de confianza del complemento y la activación efectiva antes de tratar una variable de entorno como configurada.
  • Para obtener metadatos del asistente en tiempo de ejecución que requieren código de proveedor, consulta Provider runtime hooks.
  • Si tu complemento depende de módulos nativos, documenta los pasos de compilación y cualquier requisito de lista de permitidos del administrador de paquetes (por ejemplo, pnpm allow-build-scripts + pnpm rebuild <package>).
Construcción de complementos

Introducción a los complementos.

Arquitectura del complemento

Arquitectura interna y modelo de capacidades.

Descripción general del SDK

Referencia del SDK de complementos e importaciones de subrutas.