Saltar al contenido
Menú

Documentación · MCP

Conecta Codex, Claude Code y Cursor a Fieldbook MCP

Configura tu agente para encontrar componentes, obtener código del framework y seguir instrucciones de instalación mediante Fieldbook MCP.

Sigue la guía para construir con agentes

Endpoint

https://fieldbook.lizardi.mx/api/mcp

Autenticación

Cada solicitud lleva un token Bearer. Se admiten dos tipos:

  • Clave API

    Crea una clave en tu panel y envíala como Authorization: Bearer fb_live_…. Las claves se muestran una sola vez; se guarda únicamente su hash.

  • OAuth de Clerk (si está configurado)

    Los clientes compatibles con OAuth descubren el servidor de autorización en /.well-known/oauth-protected-resource y realizan la autenticación interactiva sin introducir una clave manual.

Conectar

Define FIELDBOOK_TOKEN en el entorno desde el que abres el editor o agente. Los ejemplos usan esa variable; no guardes una clave real en el repositorio.

Codex

codex mcp add fieldbook --url https://fieldbook.lizardi.mx/api/mcp --bearer-token-env-var FIELDBOOK_TOKEN

Claude Code · .mcp.json

{
  "mcpServers": {
    "fieldbook": {
      "type": "http",
      "url": "https://fieldbook.lizardi.mx/api/mcp",
      "headers": {
        "Authorization": "Bearer ${FIELDBOOK_TOKEN}"
      }
    }
  }
}

Grok Build · ~/.grok/config.toml

[mcp_servers.fieldbook]
url = "https://fieldbook.lizardi.mx/api/mcp"
headers = { "Authorization" = "Bearer ${FIELDBOOK_TOKEN}" }

Cursor · .cursor/mcp.json

{
  "mcpServers": {
    "fieldbook": {
      "url": "https://fieldbook.lizardi.mx/api/mcp",
      "headers": {
        "Authorization": "Bearer ${env:FIELDBOOK_TOKEN}"
      }
    }
  }
}

Para clientes que requieren OAuth, usa el flujo desplegado solo cuando esté configurado y verificado. Los ejemplos anteriores son para clientes que aceptan cabeceras bearer.

Inspector MCP. Ejecuta el inspector, introduce el endpoint y configura una cabecera Authorization: Bearer para explorar las herramientas de forma interactiva.

MCP Inspector

npx @modelcontextprotocol/inspector

Herramientas

Las reglas v2 incluyen level, scopes, clusters, fineWhen y observes. suggest_alternatives resuelve los identificadores retirados a sus sucesores cuando existen. score_page acepta scope page o section e intent con ruleId y reason. Su informe cluster-v2 incluye flags con status y points, reviews, hardFails, clusters, declared y changes. Las lecturas del catálogo conservan su rulesetVersion. El cuerpo de cada solicitud admite hasta 256 KiB; usa url para páginas mayores. Las solicitudes demasiado grandes devuelven HTTP 413 con un error JSON-RPC.

Las herramientas medidas consumen créditos de tu asignación mensual. El plan del propietario no tiene medición. Las demás consultas son gratuitas y tienen límites por cuenta.

Elige una ficha. Cada componente tiene un número de ficha de cuatro dígitos. Explora el catálogo y entrega ese número a tu agente. Las herramientas de componentes aceptan plate en lugar de slug, y formatos como 0412, #412 o FB-0412 también funcionan. Cada página permite copiar el identificador y una instrucción lista para pegar.

  • search_componentsGratuito

    query?, category?, framework?, access?, maxSlopScore?, limit (max 25)

    Busca vistas previas, niveles de acceso y frameworks probados en el catálogo. Los comandos de instalación se muestran para componentes abiertos y, cuando tu plan los incluye, para componentes para miembros.

  • get_component1 crédito

    slug or plate, framework (default react)

    Obtén el código y la demo de un componente para el framework elegido, con propiedades, dependencias e instrucciones de instalación. Los componentes para miembros están incluidos en un plan Pro activo; otras cuentas reciben membership_required y no consumen créditos.

  • list_frameworksGratuito

    slug or plate

    Indica los frameworks disponibles y las versiones pendientes de un componente.

  • get_install_commandGratuito

    slug or plate, framework (default react)

    Comando de instalación, URL del registro y configuración de components.json para un componente. Los componentes para miembros están incluidos en un plan Pro activo.

  • get_design_guidanceGratuito

    query?, domain?, stack?, productType?, limit?

    Busca en la biblioteca de orientación de diseño.

  • generate_design_system2 créditos

    productType, keywords?, stack?, variance?, motion?, density?

    Genera un sistema de diseño con paleta, tipografía, composición, movimiento, reglas de UX y verificaciones.

  • get_slop_rulesGratuito

    category?, level?, scope?

    Obtén las pautas de diseño de Fieldbook para agentes de programación.

  • get_font_guidanceGratuito

    role?, family?, name?

    Explica el aspecto y comportamiento de las tipografías recomendadas, sus combinaciones y criterios.

  • suggest_alternativesGratuito

    ruleId

    Obtén alternativas sugeridas para un hallazgo de diseño.

  • score_pageGratuito

    html? | url?, scope? (page | section), intent? [{ ruleId, reason }]

    Evalúa una página con las reglas; las URLs se consultan con protección SSRF.

Registro

Instala componentes abiertos directamente o mediante el registro de components.json de abajo. Los componentes para miembros están incluidos en un plan Pro activo.

components.json

{
  "registries": {
    "@fieldbook": {
      "url": "https://fieldbook.lizardi.mx/r/react/{name}.json",
      "headers": {
        "Authorization": "Bearer ${FIELDBOOK_TOKEN}"
      }
    }
  }
}

El índice del sitio y sus endpoints para agentes está en /llms.txt.