WireBoard

Permite que agentes LLM (Claude Desktop, Cursor, VS Code, etc.) consultem suas análises em tempo real e históricas em conversa. Construído sobre o SDK JavaScript oficial @wireboard/api.

Documentação

WireBoard

wireboard-mcp

Servidor oficial do Model Context Protocol para WireBoard.

Permite que agentes de LLM (Claude Desktop, Cursor, VS Code, etc.) consultem suas análises em tempo real e históricas em conversa. Construído sobre o SDK JavaScript oficial @wireboard/api.


Instalação

Duas maneiras de instalar, escolha a que melhor se adapta à sua configuração.

Opção A: Extensão de Desktop (recomendada para usuários do Claude Desktop)

Baixe o wireboard-mcp-x.y.z.mcpb na página de lançamentos do GitHub e clique duas vezes nele. Um único arquivo funciona no Windows, macOS e Linux — o Claude Desktop já inclui seu próprio runtime Node, então não há dependências de sistema para instalar.

O Claude Desktop solicitará seu token da API WireBoard, armazenará-o com segurança no chaveiro do seu sistema operacional e as ferramentas do WireBoard ficarão disponíveis imediatamente.

Se o clique duplo não abrir o arquivo, instale-o via Claude Desktop → Configurações → Extensões → Configurações Avançadas → Instalar Extensão.

Opção B: npm install (para Cursor, VS Code, headless / CI, automação)

npm install -g @wireboard/mcp

Requer Node 18+. Em seguida, configure o cliente MCP de sua preferência.

Configuração do Claude Desktop

Edite claude_desktop_config.json (Configurações → Desenvolvedor → Editar Config):

{
  "mcpServers": {
    "wireboard": {
      "command": "wireboard-mcp",
      "env": {
        "WIREBOARD_TOKEN": "your_token_here"
      }
    }
  }
}

Reinicie o Claude Desktop. As ferramentas do WireBoard aparecerão automaticamente.

Cursor / VS Code / outros clientes MCP

Use o mesmo padrão de comando + variável de ambiente na configuração do seu cliente MCP.

Gerar um token

Você precisa de um token da API WireBoard antes que qualquer um dos métodos de instalação funcione. Gere um em Configurações → API com a habilidade analytics:read para ferramentas REST e live:read para a ferramenta de snapshot ao vivo.

O que você pode perguntar

Depois de configurado, pergunte ao Claude coisas como:

  • "Quantos visitantes meu site teve na semana passada?"
  • "Mostre-me os 10 principais referenciadores dos últimos 30 dias."
  • "O que está acontecendo no meu site agora?"
  • "Quais páginas em /checkout têm a pior taxa de rejeição este mês?"
  • "Quantos eventos Purchase foram acionados de utm_source=newsletter ontem?"
  • "Compare as contagens de visitantes dia a dia nas últimas duas semanas."

O Claude escolherá a ferramenta certa, chamará e responderá em linguagem natural.

Ferramentas disponíveis

FerramentaO que faz
list_sitesTodos os sites da conta
get_accountIdentidade do proprietário do token + habilidades
get_aggregateTotais do período: visitantes, pageviews, taxa de rejeição, duração
get_timeseriesUma métrica (visitantes ou pageviews) agrupada por hora ou dia
get_historyVisitantes/retornos/pageviews/rejeição/duração por dia
get_breakdownLinhas Top-N por dimensão (país, dispositivo, navegador, referenciador, etc.)
get_top_urlsMétricas por URL com filtros de prefixo / contém / exato
query_eventsConsultas de eventos personalizados com agrupamento e filtragem
get_live_stateSnapshot em tempo real (contagem de visitantes ao vivo, principais páginas, sessões ativas, etc.)
list_dimensionsMeta: todas as dimensões, métricas e limites que a API suporta

Todas as ferramentas aceitam intervalos de datas naturais: "today", "yesterday", "last 7 days" (ou abreviação "30d"), "this week", "last week", "this month", "last month", ou "YYYY-MM-DD..YYYY-MM-DD" explícito. Sempre em UTC.

Limite de taxa

O MCP proativamente se limita a 100 requisições/minuto (abaixo do limite de 120/minuto da API) para que rajadas de LLM se espaçem em vez de receber erros 429. Substitua com a variável de ambiente WIREBOARD_MCP_RATE_PER_MINUTE se você tiver um caso de uso que precise de ritmo diferente.

O SDK subjacente ainda faz novas tentativas automáticas em 429 como rede de segurança.

Segurança

  • Trate seu token como uma credencial. Ele tem acesso total ao escopo analytics:read e live:read em todos os sites da conta.
  • Não cometa a configuração do seu cliente MCP em um repositório público com o token nela. Use uma variável de ambiente ou um gerenciador de segredos e referencie-o a partir da sua configuração.
  • Revogue e rotacione se um token vazar. Configurações → API no seu painel.

O MCP é somente leitura: ele pode buscar dados, nunca modificá-los. A API pública do WireBoard em si é somente leitura na v1.

Registros

Os logs vão para stderr (para não interferirem no protocolo MCP na stdout).

Fonte e contribuição

Construindo localmente

npm install
npm test               # run vitest
npm run build          # bundle TS → dist/index.js (esbuild, ~600 KB)
npm run build:mcpb     # also pack dist/wireboard-mcp-<version>.mcpb

O .mcpb é um zip de manifest.json, icon.png e o único dist/index.js empacotado. Todas as dependências de runtime são embutidas pelo esbuild.

Licença

MIT.