使用说明
APIBrasil MCP Client
🌐 Idioma: Português · English
Base de conhecimento, configurações e guias para consumir o servidor MCP da APIBrasil em clientes de IA, IDEs, chatbots e ferramentas de automação.
Nota: A APIBrasil é um Gateway de APIs unificado para dados nacionais (CEP, CNPJ, Veículos, etc). Este repositório foca na integração dessas APIs via Protocolo MCP para Agentes de Inteligência Artificial.
Decisão Rápida (TL;DR)
Escolha o método de conexão baseado na natureza da sua plataforma:
| Característica | Protocolo MCP | API REST |
|---|---|---|
| Protocolo | Streamable HTTP (streaming) | HTTP Standard |
| Estado | Stateful (Sessão Persistente) | Stateless (Request/Response) |
| Uso Ideal | Cursor, Claude, Agentes de IA | n8n, Typebot, Zapier, Webhooks |
| Vantagem | Contexto contínuo para LLMs | Simplicidade e compatibilidade universal |
Endpoints
Utilize estes endereços para configurar seus clientes.
| Serviço | URL | Status |
|---|---|---|
| MCP Server | https://mcp.apibrasil.cloud/mcp |
|
| API Gateway | https://gateway.apibrasil.io/api/v2 |
|
| Docs | doc.apibrasil.io |
Comece por aqui
Selecione o seu caso de uso para ir direto à documentação específica:
| Objetivo | Diretório | Descrição |
|---|---|---|
| Conectar IA | clientes-ai/ |
Claude Desktop, LibreChat, Lovable |
| Configurar IDE | ide-editores/ |
VS Code, Cursor, Zed, JetBrains |
| Criar Chatbot | chatbots-ai/ |
Typebot, Flowise, LangFlow, Dify |
| Automação | lowcode-automacao/ |
n8n, Make, Zapier, Bubble |
| Programar | programacao/ |
Python, Node.js, Go, Java, C# |
| Entender o MCP | conceitos/ |
Credenciais, descoberta, troubleshooting |
Configurações Rápidas (Snippets)
Copie e cole as configurações abaixo diretamente no seu arquivo de preferência.
JSON Configs
- Claude Desktop:
claude_desktop_config.json - VS Code:
settings.json - Zed Editor:
settings.json
CLI Bridge (Ponte Local)
Para conectar via terminal ou clientes que só aceitam comandos stdio, use a ponte oficial mcp-remote, que converte stdio ⇆ Streamable HTTP e injeta as credenciais por header:
npx -y mcp-remote https://mcp.apibrasil.cloud/mcp \
--header "X-Apibrasil-Bearer:SEU_BEARER_TOKEN" \
--header "DeviceToken:SEU_DEVICE_TOKEN"
Como passar credenciais em cada cliente (header,
envou argumento): vejaconceitos/credenciais/.
Exemplo REST (PowerShell)
Para testes rápidos de conectividade sem depender do protocolo MCP:
$headers = @{
Authorization = "Bearer SEU_BEARER_TOKEN"
DeviceToken = "SEU_DEVICE_TOKEN"
}
$body = @{ cep = "01001000" } | ConvertTo-Json
Invoke-RestMethod -Method Post `
-Uri "https://gateway.apibrasil.io/api/v2/cep/cep" `
-Headers $headers `
-ContentType "application/json" `
-Body $body
[!IMPORTANT] Segurança e Estado
- Stateful: O MCP mantém uma sessão ativa (
Mcp-Session-Id) via Streamable HTTP. Não tente usá-lo em ambientes que matam a conexão imediatamente (como Serverless Functions puras sem stream).- Tokens: Jamais comite seus tokens reais no repositório. Utilize variáveis de ambiente ou gerenciadores de segredos.
Mapa do Repositório
Esta seção é otimizada para indexação e navegação rápida.
Índice por categoria (auto-gerado)
-
- Integração com Typebot — O Typebot executa fluxos rápidos e stateless. O protocolo MCP (que é stateful via Streamable HTTP) não é ideal para conexão direta via blocos nativos HTTP do...
- Integração com Botpress — No Botpress Studio, adicione um card Execute Code no seu fluxo.
- Integração com Dify.ai — O Dify aceita API Extensions ou Tools customizadas via OpenAPI/Swagger.
- Integração com Flowise — O Flowise é uma ferramenta Low-Code para construir LLM Apps e suporta integração via Custom Tools.
- Integração com LangFlow — O LangFlow permite criar componentes customizados em Python.
- Integração com OpenAI GPTs (Custom Actions) — Para conectar seu GPT personalizado à APIBrasil, você deve configurar uma Action usando o esquema OpenAPI (Swagger).
- Integração com Stack AI — Stack AI permite construir workflows de LLM complexos.
- Integração com Voiceflow — 1. Arraste um bloco API para o canvas.
-
- Configuração para Claude Desktop App — - Mac:
~/Library/Application Support/Claude/claude_desktop_config.json claude_desktop_config.json- Integração com 5ire — 5ire é um assistente focado em produtividade e blockchain, mas com suporte a ferramentas customizadas.
- Integração com AIaW (AI as Workspace) — 1. No painel de controle, vá em Data Sources.
- Integração com Chainlit — Chainlit é um framework Python para construir interfaces de chat (tipo Streamlit para LLMs).
- Configuração para ChatMCP — Um cliente open-source focado puramente em testar e usar servidores MCP.
- Configuração para Cherry Studio — Cherry Studio é um cliente desktop elegante para múltiplos modelos.
- Configuração para Claude Desktop App — - Mac:
~/Library/Application Support/Claude/claude_desktop_config.json - Configuração para Glue AI — Glue é uma plataforma de chat para times com suporte a Agentes.
- Configuração para HyperChat — HyperChat é um cliente desktop nativo para macOS/Windows.
- Configuração para LangDock — LangDock é uma plataforma enterprise para LLMs.
- Configuração para LibreChat — O LibreChat suporta conexões MCP remotas nativas (transporte
streamable-http), facilitando a integração. - Configuração para Lovable.dev — O Lovable conecta-se nativamente via HTTPS (Streamable HTTP), sem necessidade de adaptadores.
- Configuração para MindPal — MindPal é um cliente web focado em fluxos visuais.
- Configuração via Smithery.ai — Se o servidor estiver publicado no Smithery registry:
- Configuração para TypingMind — TypingMind é uma interface web popular para ChatGPT/Claude que suporta plugins.
- Configuração para Claude Desktop App — - Mac:
-
- Conceitos do MCP APIBrasil — Guias de referência sobre como consumir o endpoint MCP da APIBrasil — para além do "copie e cole a config". Leia estas páginas quando precisar autenticar...
- Credenciais (bearer, DeviceToken, SecretKey) — A maioria das ferramentas da APIBrasil precisa de credenciais para funcionar. Sem elas, o cliente conecta ao endpoint MCP mas toda chamada tarifada falha...
- Descoberta dinâmica — Três ferramentas cobrem qualquer serviço do gateway APIBrasil — inclusive os que ainda não têm tool dedicada. Por isso a lista de ferramentas pode ser en...
- Troubleshooting — O endpoint MCP preserva o status HTTP semântico do gateway e o transforma em um resultado
isErrorcom a mensagem original e uma dica acionável — em vez...
-
- Configuração para Cursor IDE — O Cursor conecta-se preferencialmente via comando local. Usaremos um adaptador para conectar ao servidor remoto.
- Configuração para Continue (VS Code & JetBrains) — O Continue é a principal extensão open-source que traz suporte MCP para o JetBrains (IntelliJ, PyCharm) e VS Code.
- Configuração para Cursor IDE — O Cursor conecta-se preferencialmente via comando local. Usaremos um adaptador para conectar ao servidor remoto.
- Configuração para Emacs — Para usar MCP no Emacs, recomenda-se o pacote
llmou integrações customizadas comgptel. - Configuração para Goose (Block) — Goose é um agente de IA open-source para engenharia de software.
- Configuração para JetBrains (IntelliJ, PyCharm, WebStorm) — Atualmente, o suporte nativo a MCP no JetBrains ainda está em desenvolvimento por parte da JetBrains AI.
- Configuração para PearAI — PearAI é um fork do VS Code focado em IA (similar ao Cursor), open-source.
- Configuração para Roo Code (Antigo Cline) — Roo Code é um agente autônomo para VS Code que suporta MCP nativamente.
- Configuração para Supermaven e Outros Copilots — A maioria dos assistentes de código baseados em configuração local segue o padrão JSON.
- Configuração para VS Code — Requer a extensão MCP Servers (ou compatível) instalada. (settings)
- Configuração para Windsurf (Codeium) — 1. Vá em Settings ou procure por configurações MCP no painel lateral do Windsurf.
- Configuração para Zed Editor — 1. Abra o Zed. (settings)
-
- Integração com n8n — O n8n pode consumir o servidor MCP de duas formas: usando o nó HTTP Request (para chamadas manuais) ou o nó Code (para lidar com o handshake Streamab...
- Integração com ActivePieces — ActivePieces é uma alternativa open-source ao Zapier/n8n.
- Integração com Bubble.io — O Bubble conecta-se via API Connector.
- Integração com FlutterFlow — 1. No menu esquerdo, vá em API Calls.
- Integração com Google Sheets (Apps Script) — Automatize planilhas com scripts customizados.
- Integração com Lasy.ai (IA do Ruyter / Vibe Coding) — A Lasy.ai é uma plataforma geradora de código (Text-to-App). Como ela cria o código para você (geralmente em React, Node.js ou HTML/JS), você deve **pedi...
- Integração com Make (Integromat) — O Make funciona via módulos HTTP. Assim como no n8n, sessões MCP com stream persistente não são nativas.
- Integração com n8n — O n8n é uma ferramenta de automação de fluxo de trabalho poderosa. Este guia mostra como conectar a APIBrasil usando nós nativos de HTTP Request.
- Integração com Microsoft Power Automate — 1. Vá em Data > Custom Connectors.
- Integração com Retool — Retool é ideal para painéis internos.
- Integração com Zapier — O Zapier permite rodar scripts curtos.
-
- Integração com AWS Lambda — Para usar com Bedrock Agents, defina um Action Group com o schema OpenAPI da APIBrasil.
- Integração com Azure Functions — Use a funcionalidade "Add your data" ou Function Calling conectando a este endpoint.
- Integração com Cloudflare Workers
- Integração com Discord (Discord.js)
- Integração com Google Cloud (Cloud Functions) — Se estiver usando o Vertex AI, adicione a APIBrasil como uma OpenAPI Tool importando o schema JSON (similar ao exemplo do OpenAI GPTs).
- Integração com Salesforce (Apex) — Use Callouts para conectar ao Gateway APIBrasil.
- Integração com Slack (Bolt.js) — Crie um bot Slack que consulta a APIBrasil.
- Integração com Supabase Edge Functions — Execute via Deno.
- Integração com Telegram (Telegraf)
- Integração com Vercel (Serverless Functions) — Exemplo de uma Serverless Function em Node.js que consome a APIBrasil.
-
- Consumindo APIBrasil MCP com C# (.NET) — Exemplo usando
HttpClient. - Consumindo APIBrasil MCP com Go (Golang) — Exemplo básico usando
net/http. - Consumindo APIBrasil MCP com Java — Exemplo usando Java 11+ (HttpClient nativo). Como não há SDK oficial estável para Java ainda, falamos o protocolo Streamable HTTP manualmente (POST de mensag...
- Consumindo APIBrasil MCP com Node.js — Este exemplo usa o SDK oficial do MCP para TypeScript/Node.js.
- Consumindo APIBrasil MCP com PHP — Exemplo usando Guzzle, o cliente HTTP mais popular do ecossistema PHP (padrão no Laravel).
- Consumindo APIBrasil MCP com Python — Este exemplo usa o SDK oficial
mcppara Python (asyncio). - Consumindo APIBrasil MCP com Ruby — Exemplo usando a biblioteca padrão
net/http. - Consumindo APIBrasil MCP com Rust — Exemplo usando Tokio (runtime assíncrono) e Reqwest.
- Consumindo APIBrasil via Terminal (cURL) — A maneira mais rápida de testar endpoints.
- Consumindo APIBrasil MCP com Swift — Exemplo nativo para iOS/macOS usando
URLSessioneasync/await. - Integração com Vercel AI SDK (Next.js) — Ideal para criar Chatbots com React que usam suas ferramentas.
- Consumindo APIBrasil MCP com C# (.NET) — Exemplo usando
-
- Dashboard de Vendas com Envio de WhatsApp — Este exemplo cria um painel administrativo. O objetivo é visualizar vendas e enviar comprovantes para clientes via WhatsApp com um clique.
- Formulário Inteligente (CEP e CPF) — Este exemplo cria um formulário de cadastro de alta conversão que preenche o endereço automaticamente pelo CEP e valida o CPF em tempo real.
- Bot de Rastreio de Encomendas — Script profissional em Node.js para monitorar encomendas e notificar via WhatsApp. Ideal para e-commerce ou uso pessoal.
- App de Consulta Veicular (Sinesp/Detran) — Prompt para criar uma interface mobile moderna para consulta de placas, focada em utilidade e rapidez.
- Bot de Agendamento Inteligente (Webhook) — Um servidor intermediário (Middleware) que recebe mensagens do WhatsApp, processa intenções básicas e responde.
- Disparo em Massa Inteligente (Python) — Script Python para envio de mensagens em massa com foco em segurança (anti-ban), logs detalhados e retomada de falhas.
- Enriquecimento de Dados (CRM CLI) — Ferramenta de linha de comando (CLI) profissional para consultar e enriquecer dados de empresas (B2B) usando CNPJ.
- Bot de Previsão do Tempo (Cron) — Serviço "Wake-up Call" que envia a previsão do tempo para uma lista de VIPs todas as manhãs.
- Verificador de Dias Úteis (Smart Calendar) — Módulo utilitário para verificar se uma data é dia útil, considerando fins de semana e feriados nacionais (via API). Inclui sistema de Cache em memória para...
- Monitor de Saldo (Dashboard Pessoal) — Uma ferramenta visual simples (HTML/JS) para verificar seu saldo e créditos na APIBrasil.
- Prompt para V0.dev: Central de Comunicação (CRM de WhatsApp) — Prompt otimizado para gerar uma interface de chat profissional (estilo Intercom/Zendesk) pronta para conectar com a APIBrasil.
- Prompt para Bolt.new: SaaS de KYC (Validação Cadastral) — Prompt para criar um SaaS completo de verificação de identidade usando a stack moderna do Bolt.
- Prompt para Replit Agent: Bot Sommelier — Cria um bot de WhatsApp inteligente hospedado no Replit, combinando APIBrasil (WhatsApp) e OpenAI (Inteligência).
- App Streamlit: Consulta FIPE Profissional — Interface de dados rápida para consulta de preços de veículos.
- Webhook Bridge (Cloudflare Worker) — Middleware serverless para conectar serviços externos (Stripe, Typeform) ao WhatsApp da APIBrasil.
📂 Estrutura de Pastas (Navegação)
apibrasil-mcp-client
├── assets
├── chatbots-ai
│ ├── botpress
│ ├── dify
│ ├── flowise
│ ├── langflow
│ ├── openai_gpts
│ ├── stack_ai
│ └── voiceflow
├── clientes-ai
│ ├── 5ire
│ ├── aiaw
│ ├── chainlit
│ ├── chatmcp
│ ├── cherry_studio
│ ├── claude_desktop
│ ├── glue
│ ├── hyperchat
│ ├── langdock
│ ├── librechat
│ ├── lovable
│ ├── mindpal
│ ├── smithery
│ └── typingmind
├── conceitos
│ ├── credenciais
│ ├── descoberta
│ └── troubleshooting
├── ide-editores
│ ├── continue
│ ├── cursor
│ ├── emacs
│ ├── goose
│ ├── jetbrains
│ ├── pearai
│ ├── roo_code
│ ├── supermaven
│ ├── vscode
│ ├── windsurf
│ └── zed
├── lowcode-automacao
│ ├── activepieces
│ ├── bubble
│ ├── flutterflow
│ ├── google_sheets
│ ├── lasy_ai
│ ├── make
│ ├── n8n
│ ├── power_automate
│ ├── retool
│ └── zapier
├── plataformas-cloud
│ ├── aws
│ ├── azure
│ ├── cloudflare
│ ├── discord
│ ├── google_cloud
│ ├── salesforce
│ ├── slack
│ ├── supabase
│ ├── telegram
│ └── vercel
├── programacao
│ ├── go
│ ├── java
│ ├── nodejs
│ ├── php
│ ├── python
│ ├── ruby
│ ├── rust
│ ├── shell
│ ├── swift
│ └── vercel_ai_sdk
└── vibe-coder
Para atualizar o índice auto-gerado e a árvore depois de criar/remover pastas: python scripts/update_readme_tree.py.
Termos de Busca (Tags)
[!TIP] Utilize estes termos para localizar rapidamente configurações específicas dentro dos arquivos.
| Contexto | Termo de Busca |
|---|---|
| Endpoint MCP | mcp.apibrasil.cloud/mcp |
| Ponte NPX | mcp-remote |
| Config JSON | mcpServers |
| Config Zed | "mcp": { "servers": ... } |
| Gateway REST | gateway.apibrasil.io/api/v2 |
Contribuindo
Quer adicionar uma nova ferramenta ou corrigir algo?
👉 Leia nosso Guia de Contribuição
Para manter o índice atualizado, lembre-se de rodar o script antes de commitar:
python scripts/update_readme_tree.py
