Saltar al contenido principal
Un agente de código con IA integra mejor cuando lee la documentación real en lugar de adivinar de memoria. Esta página lista los archivos que conviene darle a un agente, cómo entregarle una llave que no pueda usar mal y varios prompts para copiar que nombran las páginas que el agente debe leer primero.

Archivos hechos para agentes

Cada dirección de abajo está escrita completa: los archivos raíz están en api.listo.delivery y los archivos de la documentación están en docs.listo.delivery.
  • Índice raíz: https://api.listo.delivery/llms.txt. El primer archivo que busca un agente. Solo apunta a los demás.
  • Instrucciones para agentes: https://api.listo.delivery/AGENTS.md. Las reglas breves para un agente que trabaja en una integración, en markdown.
  • Índice de la documentación: https://docs.listo.delivery/llms.txt. Cada guía y cada página de conceptos con una descripción de una línea.
  • Todas las guías en un archivo: https://docs.listo.delivery/llms-full.txt. Una sola descarga con el texto completo de cada guía, para un agente que no puede navegar.
  • Documento OpenAPI: https://api.listo.delivery/docs/openapi.yaml. La referencia completa de /v1/, en el formato que mejor leen los generadores de código y los agentes.
  • Cualquier página en markdown: la URL de la página con .md al final. Por ejemplo https://docs.listo.delivery/es/guides/webhooks.md.
Las páginas de la referencia generada también tienen una copia en markdown, en la misma dirección con .md al final, por ejemplo https://docs.listo.delivery/es/api-reference/deliveries/create-a-delivery.md. Para la referencia completa en un solo documento, dale al agente el documento OpenAPI.

Dale a un agente una llave de solo lectura

Un agente que solo tiene que leer, listar o depurar nunca debería tener una llave que pueda crear o cancelar algo. En el panel de socios, emite la llave con Llave de solo lectura marcada. Una llave de solo lectura puede llamar los endpoints GET y HEAD (saldo, movimientos, envíos, registros de llamadas, eventos) y cualquier otra llamada, incluido reenviar un evento o enviar un webhook de prueba, responde 403 read_only_key. Una llave es de solo lectura o de acceso completo desde que se emite y nunca cambia, así que para darle más poder a un agente emites otra llave y revocas la primera. En ambos casos empieza con una llave de prueba: actúa en modo de prueba, donde nada real ocurre. Modo de prueba explica qué hace el repartidor simulado, y Sal a producción cubre las llaves para producción.
Las llaves se muestran una sola vez. Guarda la llave en una variable de entorno o en un gestor de secretos que el agente pueda leer, nunca en el prompt, en el repositorio ni en un chat.

Los errores apuntan a su solución

Cada respuesta de error trae dos campos que un agente puede usar sin adivinar:
  • doc_url: la página que explica ese error.code exacto, qué lo causa y si reintentar puede ayudar. Hay una página por código, todas en el índice de páginas de errores.
  • request_id: el mismo valor que el encabezado X-Request-Id de la respuesta. Cítalo cuando le pidas ayuda a una persona. GET /v1/request_logs lista las llamadas que hicieron tus llaves, con lo que se envió y lo que se respondió, y acepta un filtro request_id.
Depurar tu integración describe los registros de llamadas, los eventos y los intentos de entrega de webhooks que un agente puede leer por sí solo.

Conecta un cliente de IA por MCP

Si tu asistente es Claude, Cursor o Codex, puedes conectarlo al servidor MCP de Listo en lugar de pedirle que escriba llamadas HTTP. Conecta Claude, Cursor o Codex trae la dirección del servidor y la configuración de cada cliente. Una llave de solo lectura también funciona ahí: el asistente puede leer, y toda herramienta que crea, cambia o cancela algo en tu cuenta se rechaza con read_only_key, porque cada herramienta ejecuta el endpoint /v1/ que le corresponde. Una herramienta que pide confirmación se rechaza desde su primer paso, así que al asistente nunca se le muestra una vista previa que no podría confirmar. Enviar comentarios a Listo (submit_feedback) sí sigue funcionando.

Prompts para copiar

Cada prompt nombra las páginas que hay que leer. Pégalo tal cual, o agrega tus datos (tu lenguaje, tu framework, dónde está el código). El agente debe abrir las páginas antes de escribir nada.

Integrar cotizar y crear

Verificar las firmas de los webhooks

Depurar una llamada fallida por su request id

Conciliar mi saldo

Estos prompts funcionan en cualquier agente que pueda abrir una URL o leer un archivo. Si el tuyo no puede navegar, descarga una vez llms-full.txt y openapi.yaml, ponlos en el proyecto y cambia las URL del prompt por las rutas de los archivos.