Pular para o conteúdo
Menu

Documentação · MCP

Conecte Codex, Claude Code e Cursor ao Fieldbook MCP

Configure seu agente para encontrar componentes, obter o código do framework e seguir instruções de instalação pelo Fieldbook MCP.

Siga o guia de criação com agentes

Endpoint

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

Autenticação

Cada solicitação inclui um token Bearer. Dois tipos são aceitos:

  • Chave de API (disponível)

    Crie uma chave no seu painel e envie como Authorization: Bearer fb_live_…. As chaves são exibidas apenas uma vez; somente um hash é armazenado.

  • OAuth do Clerk (quando configurado)

    Clientes compatíveis com OAuth descobrem o servidor de autorização em /.well-known/oauth-protected-resource e se autenticam de forma interativa. Não é necessária uma chave manual.

Conectar

Defina FIELDBOOK_TOKEN no ambiente de inicialização do editor ou agente. Os exemplos usam essa variável; não versione uma chave API real.

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}"
      }
    }
  }
}

Cursor · .cursor/mcp.json

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

Para clientes que exigem OAuth, use o fluxo implantado apenas quando configurado e verificado. Os exemplos de chave se aplicam a clientes com cabeçalhos bearer.

MCP Inspector. Execute o inspetor, informe o endpoint e configure um Authorization: Bearer cabeçalho para explorar as ferramentas de forma interativa.

MCP Inspector

npx @modelcontextprotocol/inspector

Ferramentas

As ferramentas cobradas por uso consomem os créditos da sua cota mensal (o plano do proprietário é ilimitado). O restante é gratuito, com limite de frequência por chave.

Escolha uma ficha. Cada componente tem um número de quatro dígitos, exibido na ficha e na página. Explore o catálogo, escolha e informe o número ao seu agente: todas as ferramentas de componentes aceitam plate no lugar de slug, e formatos como 0412, #412 ou FB-0412 também funcionam. Cada página de componente tem um botão para copiar o identificador e uma instrução pronta para colar.

  • search_componentsGratuito

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

    Pesquise prévias, níveis de acesso e frameworks testados no catálogo. Os comandos de instalação aparecem para componentes abertos e, quando seu plano os inclui, para componentes para membros.

  • get_component1 crédito

    slug or plate, framework (default react)

    Obtenha o código e a demonstração de um componente para o framework escolhido, com propriedades, dependências e instruções de instalação. Os componentes para membros estão incluídos em um plano Pro ativo; outras contas recebem membership_required e não consomem créditos.

  • list_frameworksGratuito

    slug or plate

    Frameworks disponíveis para um componente e versões ainda pendentes.

  • get_install_commandGratuito

    slug or plate, framework (default react)

    Comando de instalação, URL do registro e configuração de components.json para um componente. Os componentes para membros estão incluídos em um plano Pro ativo.

  • get_design_guidanceGratuito

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

    Buscar no acervo de orientações contra o design genérico.

  • generate_design_system2 créditos

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

    Gere um sistema de design personalizado: paleta, tipografia, layout, movimento, regras de UX e lista de verificação.

  • get_slop_rulesGratuito

    category?

    As regras versionadas: número, título, gravidade, falha crítica e justificativa.

  • get_font_guidanceGratuito

    role?, family?, name?

    A aparência e o comportamento de cada fonte recomendada, com combinações testadas e seus princípios.

  • suggest_alternativesGratuito

    ruleId

    Alternativas para um padrão genérico e o catálogo de referências correspondente.

  • score_pageGratuito

    html? | url?

    Avalia uma página pelas regras (URL consultada com proteção SSRF).

Registro

Instale componentes abertos diretamente ou pelo registro components.json abaixo. Os componentes para membros estão incluídos em um plano Pro ativo.

components.json

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

Um índice do site e destes endpoints, legível por máquinas, está em /llms.txt.