Esta es una guía para colaboradores para desarrolladores del núcleo de OpenClaw. Si estás
creando un Plugin externo, consulta Crear plugins
en su lugar. Para la referencia de arquitectura detallada (modelo de capacidades, propiedad,
canalización de carga, auxiliares de runtime), consulta Aspectos internos de Plugin.
- Plugin = límite de propiedad
- capacidad = contrato compartido del núcleo
Cuándo crear una capacidad
Crea una nueva capacidad solo cuando todo lo siguiente sea cierto:- Más de un proveedor podría implementarla de forma plausible.
- Los canales, herramientas o plugins de funcionalidad deberían consumirla sin preocuparse por el proveedor.
- El núcleo necesita poseer el fallback, la política, la configuración o el comportamiento de entrega.
La secuencia estándar
- Define el contrato tipado del núcleo.
- Agrega el registro de Plugin para ese contrato.
- Agrega un auxiliar de runtime compartido.
- Conecta un Plugin de proveedor real como prueba.
- Mueve los consumidores de funcionalidad/canal al auxiliar de runtime.
- Agrega pruebas de contrato.
- Documenta la configuración visible para el operador y el modelo de propiedad.
Qué va dónde
| Capa | Posee |
|---|---|
| Núcleo | Tipos de solicitud/respuesta; registro y resolución de proveedores; comportamiento de fallback; esquema de configuración con metadatos de documentación title/description propagados en nodos de objeto anidado, comodín, elemento de arreglo y composición; superficie del auxiliar de runtime. |
| Plugin de proveedor | Llamadas a la API del proveedor, manejo de autenticación del proveedor, normalización de solicitudes específica del proveedor y registro de la implementación de capacidad. |
| Plugin de funcionalidad/canal | Llama a api.runtime.* o al auxiliar plugin-sdk/*-runtime correspondiente. Nunca llama directamente a una implementación de proveedor. |
Costuras de proveedor y arnés
Usa hooks de proveedor cuando el comportamiento pertenezca al contrato del proveedor del modelo en lugar de al bucle genérico del agente. Los ejemplos incluyen parámetros de solicitud específicos del proveedor después de la selección de transporte, preferencia de perfil de autenticación, superposiciones de prompts y enrutamiento de fallback de seguimiento después de la conmutación por error de modelo/perfil. Usa hooks de arnés de agente cuando el comportamiento pertenezca al runtime que está ejecutando un turno. Los arneses pueden clasificar resultados explícitos del protocolo, como salida vacía, razonamiento sin salida visible o un plan estructurado sin respuesta final, para que la política externa de fallback del modelo pueda tomar la decisión de reintento. Mantén ambas costuras estrechas:- El núcleo posee la política de reintento/fallback.
- Los plugins de proveedor poseen sugerencias específicas del proveedor sobre solicitud/autenticación/enrutamiento.
- Los plugins de arnés poseen la clasificación de intentos específica del runtime.
- Los plugins de terceros devuelven sugerencias, no mutaciones directas del estado del núcleo.
Lista de archivos
Para una nueva capacidad, espera tocar estas áreas:src/<capability>/types.tssrc/<capability>/...registry/runtime.tssrc/plugins/types.tssrc/plugins/registry.tssrc/plugins/captured-registration.tssrc/plugins/contracts/registry.tssrc/plugins/runtime/types-core.tssrc/plugins/runtime/index.tssrc/plugin-sdk/<capability>.tssrc/plugin-sdk/<capability>-runtime.ts- Uno o más paquetes de Plugin incluidos.
- Configuración, documentación, pruebas.
Ejemplo desarrollado: generación de imágenes
La generación de imágenes sigue la forma estándar:- El núcleo define
ImageGenerationProvider. - El núcleo expone
registerImageGenerationProvider(...). - El núcleo expone
api.runtime.imageGeneration.generate(...)y.listProviders(...). - Los plugins de proveedor (
comfy,deepinfra,fal,google,litellm,microsoft-foundry,minimax,openai,openrouter,vydra,xai) registran implementaciones respaldadas por proveedores. - Los proveedores futuros registran el mismo contrato sin cambiar canales/herramientas.
agents.defaults.imageModelanaliza imágenes.agents.defaults.imageGenerationModelgenera imágenes.
Proveedores de embeddings
UsaregisterEmbeddingProvider(...) / contrato embeddingProviders para
proveedores reutilizables de embeddings vectoriales. Este contrato es intencionalmente más amplio
que la memoria: herramientas, búsqueda, recuperación, importadores o futuros plugins de funcionalidad
pueden consumir embeddings sin depender del motor de memoria. La búsqueda de memoria
también consume embeddingProviders genéricos.
La API de registro anterior específica de memoria y el contrato memoryEmbeddingProviders
están obsoletos. Usa registerEmbeddingProvider y
embeddingProviders para todos los nuevos proveedores de embeddings.
Lista de revisión
Antes de publicar una nueva capacidad, verifica:- Ningún canal/herramienta importa código de proveedor directamente.
- El auxiliar de runtime es la ruta compartida.
- Al menos una prueba de contrato afirma la propiedad incluida.
- La documentación de configuración nombra la nueva clave de modelo/configuración.
- La documentación de Plugin explica el límite de propiedad.
Relacionado
- Aspectos internos de Plugin — modelo de capacidades, propiedad, canalización de carga, auxiliares de runtime.
- Crear plugins — tutorial del primer Plugin.
- Resumen del SDK — referencia del mapa de importaciones y la API de registro.
- Crear Skills — superficie complementaria para colaboradores.