Producto
CLI

Validar agente

Valida un archivo JSON de agente contra el schema oficial.

Validar un archivo de agente

Valida un archivo JSON de agente contra el schema oficial antes de usarlo en create o update. Funciona sin conexión y sin sesión.

bash
01plazbot agent validate <file> [options]

Parámetros

ParámetroFlagRequeridoDescripción
file(posicional)SíRuta al archivo JSON del agente.
Estricto--strictNoTambién falla con propiedades desconocidas en objetos anidados (detecta errores de tipeo). Por defecto: false.
Crudo--rawNoImprime los errores de AJV sin procesar, como JSON. Por defecto: false.
JSON--jsonNoImprime el resultado como JSON ({"valid","errors":[{"path","message"}]}). Por defecto: false.

Ejemplos

bash
01# Validar un archivo exportado
02plazbot agent validate ./agent.json
03 
04# Detectar también propiedades desconocidas (typos)
05plazbot agent validate ./agent.json --strict
06 
07# Resultado legible por máquina (código de salida 1 si es inválido)
08plazbot agent validate ./agent.json --json

Resultado

Archivo válido:

text
01 Valid schema
02 The agent "Asistente de Ventas" matches the official schema.

Con --strict termina en (strict mode).

Archivo inválido (código de salida 1):

text
01 Invalid schema (4 errors):
02 
03 1. (root): missing required property 'prompt'
04 2. (root): missing required property 'zone'
05 3. buffer: must be of type integer
06 4. instructions -> tone: must be of type string
07 
08 Tip: use --raw to inspect the AJV errors as JSON.

Los campos obligatorios en la raíz son name, prompt, zone y buffer (entero de 3 a 20). En la raíz no se permiten propiedades desconocidas; --strict aplica la misma regla a los objetos anidados.

Salida JSON

json
01{
02 "valid": false,
03 "errors": [
04 { "path": "(root)", "message": "missing required property 'prompt'" },
05 { "path": "buffer", "message": "must be of type integer" }
06 ]
07}

Si el archivo es válido: {"valid": true, "errors": []}. Si el JSON tiene un error de sintaxis, con --json se imprime valid: false con un único error en (root) que empieza por Invalid JSON syntax:.

Con --raw se imprime el arreglo de errores de AJV (instancePath, schemaPath, keyword, params, message).

Errores comunes

MensajeCausaSolución
File not found: <ruta>La ruta no existe.Revisa la ruta del archivo.
Invalid JSON syntax: ...El archivo no es JSON válido.Corrige la sintaxis en la posición indicada.
unknown property '<nombre>'Hay un campo que el schema no admite (en la raíz, o anidado con --strict).Corrige el nombre del campo o elimínalo.
¿Quieres probar la API en vivo? Abre el Playground.