- Leer: recuperar datos. Siempre disponible.
- Escribir: crea o actualiza datos. Deshabilitado durante la versión beta.
{resource}:{action} y coinciden con Public API catálogo de alcance. Asígnalos a tu aplicación en Admin → API Access.
Convenciones
La superficie de la herramienta MCP refleja las formas de solicitud/respuesta Public API, por lo que llama al puerto 1:1 entre las dos. Paginación. Todas las herramientas de búsqueda aceptanpage (basado en 0, predeterminado 0) y pageSize (predeterminado 25, máximo 100). Las respuestas reflejan la solicitud page para que los agentes puedan manejar su propio buscapersonas. page=-1 (o cualquier valor negativo) se rechaza con [invalid_params].
Filtros de matriz. Filtros que se asignan a campos de matriz /search en Public API (statuses, status, loadNumbers, orderNumbers, mcNumbers, dotNumbers, tripNumbers, driverIds, etc.) se declaran como matrices en la herramienta. Pase uno o varios valores en una sola llamada.
Intervalos de fechas. Los filtros de intervalo de fechas son objetos: { start, end } en ISO-8601 (por ejemplo, { "start": "2026-06-01T00:00:00Z", "end": "2026-06-30T23:59:59Z" }). Los nombres de los parámetros coinciden con Public API — createdDateRange, pickupDateRange, deliveryDateRange, invoicedDateRange, paidDateRange, transactionRange. Los parámetros de cadena dividida heredados (createdFrom/createdTo, pickupFrom/pickupTo, etc.) ya no se aceptan.
Argumentos estrictos. Las claves desconocidas — errores ortográficos, filtros no admitidos o parámetros que ya no existen — se rechazan con [invalid_params]. El mensaje de error nombra las claves rechazadas y la lista de parámetros válidos para que un agente pueda autocorregirse en una sola ronda. Las claves anidadas dentro de un rango de fechas o un elemento de matriz también se validan. Los argumentos obligatorios faltantes y los valores de tipo incorrecto (por ejemplo page: "not-an-int") también devuelven errores estructurados [invalid_params] que nombran el parámetro — tanto para herramientas como para prompts.
Por qué: anteriormente, el SDK MCP vinculaba los argumentos por nombre y descartaba silenciosamente los desconocidos.
customers_search name="Colortech" devolvió la lista completa de clientes sin filtrar porque name no es un filtro válido en esa herramienta. Ese comportamiento de descarte silencioso desapareció: ahora obtiene un error accionable en lugar de un resultado confiadamente incorrecto.annotations de MCP que reflejan los niveles Read / Write / Destructive de esta página: readOnlyHint, destructiveHint, idempotentHint y openWorldHint. Su cliente MCP puede usar estas indicaciones para decidir si pedir confirmación a un humano antes de ejecutar una herramienta. Durante la beta, cada herramienta expuesta es de solo lectura y establece readOnlyHint: true (y destructiveHint: false).
Ejemplo de rechazo:
Cargas
Viajes
Conductores
Transportistas
Clientes
Camiones y remolques
Facturas, combustible y pagos
Accesorios y créditos
Los accesorios son cargos adicionales generados en un carga o viaje. Los créditos reducen lo que se debe. Ambos usan los mismos datos de referencia: llame primero aaccessorials_list_types para obtener el typeId, los ids rateType que ese tipo permite y los ids rateUom válidos para cada uno de esos tipos de tarifa.
No existe una herramienta de crédito para conductores. Un crédito de conductor es un objeto distinto de un accesorio — un registro de liquidación, no un cargo en un viaje — y se crea a través de la Public API con Create driver credit, que usa el alcance
deduction:create.
Tipo de tarifa y unidad de medida
rateType y rateUom se envían como ids, y las combinaciones válidas provienen de accessorials_list_types para el tipo que está cobrando.
quantity debe ser mayor que cero, excepto con un rateType Plana, que factura la tarifa una vez y fuerza la cantidad a 1.
Envíe stopId cuando el tipo de accesorio devuelva RequiresStop: true.
Idempotencia en escrituras de accesorios y créditos
Cada herramienta de creación acepta unexternalId opcional: su propia clave para el registro, única dentro de su inquilino. Envíe el mismo valor en un reintento y se devuelve el registro original en lugar de crearse un segundo. Omítalo y un reintento crea un segundo registro.
- Las claves distinguen mayúsculas de minúsculas y se comparan después de recortar los espacios en blanco circundantes.
- Un reintento debe pedir el mismo trabajo: el mismo
rate,quantity,rateType,rateUomy (para accesorios de conductor)applyDriverRate, además del mismo viaje o carga, tipo de accesorio, parada y conductor. Reutilizar una clave con cualquiera de esos elementos cambiado se rechaza con409. notesno se compara. Un reintento con una nota corregida devuelve el original sin cambios.- Una clave permanece gastada después de eliminar el accesorio y no se puede reutilizar entre tipos (conductor, cliente, transportista).
Visibilidad y seguimiento
Deducciones
Licitaciones
Manejo de errores
Las llamadas a herramientas devuelven un error estructurado cuando no pueden completarse. Casos comunes:Relacionado
Protocolo de contexto modelo
Descripción general y configuración de la conexión para el servidor Alvys MCP.
Autenticación
Cree credenciales y emita tokens de acceso con los alcances correctos.