Files
fit-boilerplate-wox/INSTRUCCIONES.md
Felipe Arentsen b089c2ef18
Some checks failed
CI — Lint + Evals / lint (push) Has been cancelled
CI — Lint + Evals / smoke (push) Has been cancelled
feat: v1 — boilerplate WxO + web
Boilerplate completo para construir soluciones agénticas sobre IBM
watsonx Orchestrate (ADK 2.x) con una capa web encima.

Destilado de cotemar-poc-n1 y dun-casos-prueba. Incluye:

- 11 docs (best practices, architecture patterns, ADK cheatsheet,
  observability, tool authoring, deployment, RUNBOOK, DEPLOY_TO_NEW_WOX,
  known-issues con 16 errores reales y fix, eval strategy, INDEX)
- 13 templates WxO (orchestrator/specialist/single-meta agents,
  3 connections, KB + runbook, observable_tool decorator, coercion
  helpers, Python tools, OpenAPI spec, backend filter endpoint, webhook
  validator HMAC, MCP connection)
- 6 scripts (deploy idempotente con fallback ADK, undeploy, reset,
  check-adk-version, new-specialist scaffold, eval-agents runner)
- 4 eval pieces (linter de best practices, runner, smoke-test, direct
  backend probe) + scenario templates
- 8 subagentes Claude (.claude/agents/) — wxo-architect, wxo-agent-author,
  wxo-tool-author, runbook-author, mock-builder, backend-tool-builder,
  eval-author, web-layer-builder
- Skill bundle fit-wxo-bootstrap/ (SKILL.md + 3 templates) listo para
  copiar a ~/.claude/skills/
- Web layer default FastAPI+HTMX con vista timeline observable + endpoint
  receptor de trazas
- Docker compose Coolify-ready (healthcheck wget -qO-, sin labels Traefik,
  network split internal:true)
- CI Gitea workflow con lint + smoke

Best practices enforced por evals/lint_wxo_yaml.py:
- A1: máx 10 tools por agente
- A3: orchestrator sin tools de remediación
- A6: agente sin propósito (react sin tools ni KB)
- T1: @observable_tool obligatorio, no @tool directo
- T3: _compat shim inline en tools.py
- D1: docker-compose sin wget --spider
- I-005: OpenAPI con description per-operation
- I-009: sin labels Traefik manuales

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-16 14:59:44 +00:00

2.5 KiB

Instrucciones — Quickstart en 5 pasos

1. Clonar y limpiar

git clone https://gitea.fitlabs.dev/farentsen/fit-boilerplate-wox.git mi-cliente
cd mi-cliente
rm -rf .git && git init
git add . && git commit -m "chore: bootstrap from fit-boilerplate-wox"

2. Configurar entorno

cp .env.example .env
# Editar .env con:
#   ORCHESTRATE_API_URL    — URL del tenant WxO
#   ORCHESTRATE_API_KEY    — API key del tenant
#   WATSONX_API_KEY        — (opcional) si usás Plan A webhook
#   PUBLIC_HOST            — dominio público donde corre tu stack

3. Registrar el environment WxO

python3.12 -m venv .venv-wxo && source .venv-wxo/bin/activate
pip install --upgrade "ibm-watsonx-orchestrate==2.1.0"

orchestrate env add -n mi-tenant \
  --iam-url https://iam.cloud.ibm.com/identity/token \
  -u "$ORCHESTRATE_API_URL"
orchestrate env activate mi-tenant

Verificar modelo:

orchestrate models list | grep gpt-oss-120b   # preferido para tool calling

Si no está, editá los YAMLs de los agentes generados y poné meta-llama/llama-3-3-70b-instruct (con la advertencia de docs/known-issues.md sobre el bug de tool-call-as-text).

4. Generar tu solución con la skill

Instalá el skill primero (una sola vez por máquina):

cp -r skill/fit-wxo-bootstrap ~/.claude/skills/

En una sesión de Claude Code, ejecutá:

"Quiero arrancar una solución WxO para [tu caso de uso]"

La skill te pregunta:

  1. ¿Qué cliente/caso de uso?
  2. ¿Cuántos dominios identificás?
  3. ¿Tu backend ya existe o lo hacemos como mock?
  4. ¿Qué stack web (default HTMX o React)?

Luego dispara subagentes Claude en paralelo que escriben todos los YAMLs, tools, runbooks, evals y la app web.

5. Validar y desplegar

./scripts/check-adk-version.sh        # avisa si hay versión nueva del ADK
python3 evals/lint_wxo_yaml.py        # falla si rompiste alguna best practice
./scripts/deploy-wxo.sh               # idempotente: conexiones + tools + KBs + agents + canal
./evals/smoke-test.sh                 # end-to-end smoke

Paso manual obligatorio después del deploy:

WxO Console → Settings → Embed Security → Off

Sin esto, el embed widget en tu landing page se queda en "Cargando agente…" para siempre.

Siguientes pasos

  • docs/architecture-patterns.md — para decisiones de diseño
  • docs/wxo-best-practices.md — las reglas que el linter enforcea
  • docs/known-issues.md — si algo falla, mirá acá primero