Documentación para agentes de IA (Agent Experience)
Esta documentación está optimizada para ser consumida por agentes de IA (Claude Code, ChatGPT, Cursor, Copilot) además de por humanos. Seguimos el estándar llms.txt y las prácticas de Agent Experience adoptadas por Anthropic, Stripe y Vercel.
Recursos disponibles
| Recurso | URL | Para qué |
|---|---|---|
| Índice llms.txt | /llms.txt | Mapa curado de páginas (markdown) — punto de entrada para agentes |
| Ingestión completa | /llms-full.txt | Toda la documentación en un solo archivo |
| Companion markdown | <página>.md | Cada página tiene su gemelo en markdown limpio (p. ej. /empezar/quickstart.md) |
| Contrato de la API | /openapi/BeTrust_KYC_API.yaml | OpenAPI 3.0 — fuente de verdad, para generar integraciones |
| AGENTS.md | /AGENTS.md (repo) | Instalación, configuración y convenciones del repo de docs |
| robots.txt | /robots.txt | Bots de IA permitidos explícitamente |
Cómo lo usa un agente
- Lee
/llms.txtpara orientarse y elegir páginas relevantes. - Descarga el
.mdde cada página (texto canónico, sin HTML, a baja huella de tokens). - Para escribir código de integración, consume el OpenAPI directamente.
Convenciones que lo hacen "agent-friendly"
- Cada endpoint de la referencia es autocontenido: método, path, parámetros, ejemplo de request/response y errores, todo inline.
- Bloques de código siempre con identificador de lenguaje y datos de ejemplo reales.
- Errores documentados de forma exhaustiva con código programático + descripción legible (ver Catálogo de estados).
Roadmap
- Servidor MCP de la documentación (
search_docs/get_doc_page/list_docs) para que los agentes consulten BeTrust vía Model Context Protocol.[POR HACER] - "Ask AI" (chat sobre las docs).
[POR HACER] - SDKs generados desde el OpenAPI (TypeScript/Python/Go) publicados y sincronizados en CI.
[POR HACER]