run_page_audit

Tool MCP run_page_audit : queue un Page Audit sur une URL. Respecte le quota de plan (Growth 4/mois, Pro 10/mois) et le cap credits Agency. Retourne un auditId ; l'audit complète en async.

Mis à jour le 2026-05-07

run_page_audit

run_page_audit queue un Page Audit sur une URL et renvoie un auditId immédiatement. L'audit tourne en async (typiquement 30–90 secondes) et passe par PENDING → GENERATING → COMPLETED. Pollez get_page_audit pour récupérer les modifications quand prêt.

Requiert au moins le rôle member. Le rôle customer est rejeté.

Billing

Le coût dépend du plan :

Plan Coût Limite
Starter n/a Page audits non inclus ; le tool renvoie quota_exceeded:disabled.
Growth Gratuit 4 audits par mois facturé.
Pro Gratuit 10 audits par mois facturé.
Agency 100 credits Illimité ; capped par monthlyOverageCapEuros si défini.

L'éligibilité est vérifiée avant que l'audit soit queue. Si le workspace ne peut pas en lancer un de plus, le tool retourne une erreur quota_exceeded structurée et aucun travail n'est démarré.

En dev (NODE_ENV=development), l'éligibilité et le débit credits sont bypass.

Cycle de vie async

  1. run_page_audit renvoie { success: true, auditId, status: "PENDING" }.
  2. Pollez get_page_audit avec l'auditId. Tant que PENDING/GENERATING, la réponse est minimale.
  3. À COMPLETED, get_page_audit renvoie le summary complet et les modifications.
  4. À FAILED, get_page_audit renvoie un errorMessage.

Input

Champ Type Description
projectId string (CUID) Projet ciblé.
pageUrl string (URL) URL complète de la page à auditer. Doit être en https:// et publiquement accessible.

Response

Succès — audit queue

{
  "success": true,
  "auditId": "clx_rep_42",
  "status": "PENDING",
  "plan": "AGENCY",
  "mode": "credits",
  "creditsCharged": 100,
  "remainingCredits": 4900,
  "message": "Audit queued. Poll get_page_audit with this auditId to fetch results when status transitions to COMPLETED."
}

Pour Growth/Pro, la réponse a mode: "quota" et remainingAuditsThisMonth au lieu de creditsCharged/remainingCredits.

Erreur — quota dépassé

{
  "success": false,
  "ok": false,
  "error": "quota_exceeded",
  "plan": "GROWTH",
  "reason": "quota_reached",
  "auditsThisPeriod": 4,
  "quotaPerMonth": 4,
  "upgradeUrl": "/billing",
  "message": "Workspace cannot run another page audit right now. Inspect the `reason` and either upgrade or raise the overage cap."
}

reason peut être :

  • disabled — le plan n'inclut pas les page audits (Starter).
  • quota_reached — Growth/Pro a atteint le cap mensuel ; renouvellement à la période suivante.
  • insufficient_credits — Agency a atteint le cap d'overage ; augmenter monthlyOverageCapEuros ou attendre le renouvellement.

Erreur — fetch échoué

{
  "success": false,
  "ok": false,
  "error": "fetch_failed",
  "message": "Could not fetch the page. The URL may be private, redirecting, or blocking crawlers."
}

Aucun credit n'est débité si la page ne peut pas être fetched.

Tips et patterns

  • Toujours check success d'abord, puis brancher sur error pour les cas structurés ci-dessus.
  • De-dup avant de queue. list_missed_citations renvoie hasExistingAudit ; ne lancez l'audit que sur les URL avec false.
  • Pollez, ne bloquez pas. Bouclez get_page_audit toutes les 10–20 secondes. Plus serré ne sert à rien — l'audit est borné par un appel LLM, pas par le polling.
  • Surfacez le coût à l'user. Sur Agency, creditsCharged et remainingCredits donnent à l'agent tout pour rendre une ligne "100 credits utilisés, 4 900 restants".

Tools liés