Building plugins
Adición de funcionalidades (guía para colaboradores)
Use esto cuando OpenClaw necesite un nuevo dominio compartido, como embeddings, generación de imágenes, generación de vídeo o alguna futura área de funcionalidad respaldada por proveedores.
La regla:
- plugin = límite de propiedad
- capacidad = contrato compartido del núcleo
No conecte un proveedor directamente a un canal o una herramienta. Defina primero la capacidad.
Cuándo crear una capacidad
Cree una capacidad nueva solo cuando se cumplan todas estas condiciones:
- Más de un proveedor podría implementarla de forma plausible.
- Los canales, las herramientas o los plugins de funcionalidades deben poder consumirla sin preocuparse por el proveedor.
- El núcleo debe controlar el fallback, la política, la configuración o el comportamiento de entrega.
Si el trabajo es exclusivo de un proveedor y todavía no existe un contrato compartido, defina primero el contrato.
Secuencia estándar
- Defina el contrato tipado del núcleo.
- Añada el registro de plugins para ese contrato.
- Añada un auxiliar compartido de tiempo de ejecución.
- Conecte un plugin de proveedor real como prueba.
- Migre los consumidores de funcionalidades o canales al auxiliar de tiempo de ejecución.
- Añada pruebas de contrato.
- Documente la configuración orientada al operador y el modelo de propiedad.
Qué corresponde a cada lugar
| Capa | Controla |
|---|---|
| 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 objetos anidados, comodines, elementos de matrices y composiciones; superficie del auxiliar de tiempo de ejecución. |
| Plugin de proveedor | Llamadas a la API del proveedor, gestión de la autenticación del proveedor, normalización de solicitudes específica del proveedor y registro de la implementación de la 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. |
Puntos de integración de proveedores y arneses
Use hooks de proveedor cuando el comportamiento pertenezca al contrato del proveedor del modelo, en lugar de al bucle genérico del agente. Algunos ejemplos son los parámetros de solicitud específicos del proveedor después de seleccionar el transporte, la preferencia de perfiles de autenticación, las superposiciones de prompts y el enrutamiento de fallback posterior tras el failover del modelo o del perfil.
Use hooks del arnés del agente cuando el comportamiento pertenezca al tiempo de ejecución que ejecuta un turno. Los arneses pueden clasificar resultados explícitos del protocolo, como una 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 decidir si se reintenta.
Mantenga reducidos ambos puntos de integración:
- El núcleo controla la política de reintentos y fallback.
- Los plugins de proveedores controlan las indicaciones específicas del proveedor sobre solicitudes, autenticación y enrutamiento.
- Los plugins de arneses controlan la clasificación de intentos específica del tiempo de ejecución.
- Los plugins de terceros devuelven indicaciones, no modificaciones directas del estado del núcleo.
Lista de comprobación de archivos
Para una capacidad nueva, normalmente será necesario modificar 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 plugins incluidos.
- Configuración, documentación y pruebas.
Ejemplo práctico: generación de imágenes
La generación de imágenes sigue la estructura 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 proveedores (
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 los canales ni las herramientas.
La clave de configuración se mantiene separada intencionadamente del enrutamiento del análisis visual:
agents.defaults.imageModelanaliza imágenes.agents.defaults.mediaModels.imagegenera imágenes.
Manténgalos separados para que el fallback y la política sigan siendo explícitos.
Proveedores de embeddings
Use registerEmbeddingProvider(...) / contrato embeddingProviders para
proveedores reutilizables de embeddings vectoriales. Este contrato es intencionadamente más amplio
que la memoria: las herramientas, la búsqueda, la recuperación, los importadores o los futuros plugins de funcionalidades
pueden consumir embeddings sin depender del motor de memoria. La búsqueda en memoria
también consume embeddingProviders genéricos.
La API anterior de registro específica de la memoria y el contrato memoryEmbeddingProviders
están obsoletos. Use registerEmbeddingProvider y
embeddingProviders para todos los proveedores de embeddings nuevos.
Lista de comprobación para la revisión
Antes de publicar una capacidad nueva, verifique lo siguiente:
- Ningún canal ni herramienta importa directamente código de proveedores.
- El auxiliar de tiempo de ejecución es la ruta compartida.
- Al menos una prueba de contrato comprueba la propiedad incluida.
- La documentación de configuración indica el nuevo modelo o la nueva clave de configuración.
- La documentación de plugins explica el límite de propiedad.
Si un PR omite la capa de capacidades y codifica directamente el comportamiento del proveedor en un canal o una herramienta, devuélvalo y defina primero el contrato.
Contenido relacionado
- Aspectos internos de los plugins — modelo de capacidades, propiedad, pipeline de carga y auxiliares de tiempo de ejecución.
- Creación de plugins — tutorial para crear el primer plugin.
- Descripción general del SDK — referencia del mapa de importaciones y la API de registro.
- Creación de Skills — superficie complementaria para colaboradores.