Saltar al contenido
ProductOnboard

Documentación

Documentación para agentes, escrita para agentes

Aplicamos a nuestra propia documentación lo que recomendamos: un camino, ejemplos completos, errores literales y verificación explícita.

API públicaArtefactosIntegración continuaHoja de ruta

API pública

Un endpoint, sin autenticación, para el escaneo estático

El escaneo de descubrimiento, comprensión y documentación está abierto. Los Agent Runs requieren cuenta y clave de API.

POST/api/scan

Escanea un origen público y devuelve el informe completo: comprobaciones, hallazgos priorizados, artefactos generados y escenarios sugeridos.

urlstring, obligatorio. Dominio o URL pública.

Límite: 8 peticiones por minuto y origen. Timeout por sonda: 8 s.

Códigos de respuesta

200Informe completo en el cuerpo.
400Falta el campo url o el JSON es inválido.
422El dominio no es escaneable: privado, caído o inaccesible.
429Límite de peticiones superado.
curl
curl -X POST https://productonboard.com/api/scan \
  -H 'content-type: application/json' \
  -d '{"url": "acme.com"}'
respuesta (recortada)
{
  "target": "https://acme.com",
  "productName": "Acme Cloud",
  "staticScore": 71,
  "dimensions": [
    { "dimension": "discovery",     "score": 78 },
    { "dimension": "understanding", "score": 74 },
    { "dimension": "documentation", "score": 61 }
  ],
  "checks": [
    {
      "id": "llms-txt",
      "label": "llms.txt publicado",
      "status": "fail",
      "weight": 10,
      "evidence": "No existe /llms.txt…",
      "fix": "Publica /llms.txt con el resumen…"
    }
  ],
  "findings": [ … ],
  "artifacts": {
    "llmsTxt": "# Acme Cloud\n\n> …",
    "agentsMd": "# AGENTS.md — Acme Cloud\n…"
  },
  "scenarios": [ … ],
  "surface": {
    "softNotFound": false,
    "probes": [ { "path": "/llms.txt", "status": 404, "ok": false } ]
  }
}

Cómo interpretamos un 200

Un 200 no demuestra que un archivo exista. Muchos sitios redirigen cualquier ruta desconocida a una página que responde 200. Por eso cada sonda se valida contra el tipo de contenido, el cuerpo y la URL final, y lanzamos además una sonda de control a una ruta que no puede existir. Si esa sonda «existe», marcamos el resto como no concluyente en lugar de inflar la puntuación.

Artefactos

Qué generamos y por qué así

llms.txt

El índice que un agente lee primero. Resumen, cuándo usar el producto, cuándo no, cómo empezar y enlaces canónicos.

llms-full.txt

La documentación completa en texto plano, para agentes con ventana de contexto grande.

AGENTS.md

Instrucciones operativas: fuentes canónicas, flujos, reglas de seguridad, verificación y errores frecuentes.

Skills por agente

Claude Skills, Codex Skills, Cursor Rules, Gemini Instructions y Copilot Instructions a partir del mismo contenido.

Nunca inventamos lo que no hemos observado

Todo lo que el escaneo no puede verificar aparece como TODO en el artefacto generado. Un llms.txt verosímil pero incorrecto es peor que uno incompleto: el incompleto se completa, el incorrecto se propaga a todos los agentes que lo lean.

Integración continua

Agent Gate en cada pull request

Una mejora que no se vigila se revierte sola. El gate bloquea el merge cuando la tasa de éxito cae por debajo del umbral que definas.

.github/workflows/agent-gate.yml
name: Agent Gate

on: [pull_request]

jobs:
  agent-readiness:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: ProductOnboard scan
        uses: productonboard/agent-gate@v1
        with:
          api-key: ${{ secrets.PRODUCTONBOARD_API_KEY }}
          target: ${{ steps.preview.outputs.url }}
          scenarios: quickstart,api-auth,mcp-tools
          fail-under: 75          # bloquea si el score cae
          compare-to: main        # detecta regresiones

Hoja de ruta

Qué está construido y qué viene después

Publicamos el estado real de cada pieza. Es la misma transparencia que le pedimos a nuestros clientes en su documentación.

disponible

Fase 1 — Discover + Understand

  • Escáner de descubrimiento en vivo
  • Validación anti soft-404
  • Puntuación por dimensiones
  • Hallazgos priorizados con impacto
  • Generador de llms.txt y AGENTS.md
  • Escenarios sugeridos
  • API pública sin autenticación
en construcción

Fase 2 — Test + Verify

  • Runner en contenedor aislado
  • Claude Code y Codex
  • Evaluadores de comandos, HTTP y archivos
  • Timeline de ejecución
  • Task Success Score
  • Cuentas y organizaciones
  • Stripe y planes Free, Launch y Startup
planificado

Fases 3 a 5

  • Improvement Copilot y pull requests
  • Skill Builder por agente
  • Agent Gate en CI
  • Comparación entre agentes y versiones
  • Monitorización de producción
  • Certificación pública
  • Escenarios internos y despliegue privado

Lo que no vamos a construir todavía

On-premise, SAML, SCIM, marketplace, grabación de vídeo completa, comparativas públicas automatizadas, integración con todos los agentes, aplicación móvil y editor no-code complejo. Cada una es defendible; ninguna acerca el primer resultado a los quince minutos.