Skip to main content
BD

Banco do Brasil

@codespar/mcp-banco-do-brasil · v0.1.0-alpha.5

🇧🇷 BrasilBancosAuth · OAuth2beta13 ferramentas8 variáveis de ambienteversão prévia

Maior banco público do BR (o maior por ativos). OAuth2 + mTLS + gw-dev-app-key. Pix, DICT, cobranças de boleto, conta-corrente. Alpha no npm — devportal fechado por contrato, paths seguem o padrão BACEN.

Comece · grátisVer docs

MIT · roda localmente com as suas credenciais

Variáveis de ambiente, nomes e descrições das ferramentas vêm do pacote npm e ficam em inglês.

Limitações

  • A v0.1.0-alpha.5 é uma versão prévia; o npm não tem versão estável deste pacote.
  • O manifesto do pacote não declara 2 das 8 variáveis que o código lê.
  • Chamadas hospedadas com chave de teste não estão disponíveis: conectar este provedor exige credenciais que ele emite para um operador.
Pacote
@codespar/mcp-banco-do-brasil
Versão
0.1.0-alpha.5 · versão prévia
dist-tag npm
latest
Categoria
Bancos
Auth
OAuth2
País
🇧🇷 Brasil
Licença
MIT
Transporte
stdio

Início rápido

Instale, configure as credenciais, faça a primeira chamada.

Escolha seu cliente. O servidor roda localmente via stdio, com as suas credenciais.

Adicione o servidor ao seu clienteUma entrada de configuração. Sem build, sem SDK.
Defina as variáveis de ambiente8 variáveis lidas pelo código deste servidor, listadas abaixo.
Reinicie e faça a primeira chamadaO agente pode chamar qualquer uma das 13 ferramentas. Comece por create_pix_cob.
terminal
# Claude Code claude mcp add banco-do-brasil -e BB_AUTH_URL=… -e BB_BASE_URL=… -e BB_CERT_PATH=… -e BB_CLIENT_ID=… -e BB_CLIENT_SECRET=… -e BB_DEVELOPER_APP_KEY=… -e BB_ENV=… -e BB_KEY_PATH=… -- npx -y @codespar/mcp-banco-do-brasil@0.1.0-alpha.5 # then: /mcp to confirm the server is connected
Variáveis de ambiente8 variáveis
BB_AUTH_URLLida pelo código; o manifesto do pacote não a declara.
BB_BASE_URLLida pelo código; o manifesto do pacote não a declara.
BB_CERT_PATHAbsolute path to the mTLS client certificate (.crt or .pem). BACEN mandates mTLS for Pix v2 in production.opcional
BB_CLIENT_IDBanco do Brasil OAuth client_id issued via developers.bb.com.br after contract onboarding.obrigatória
BB_CLIENT_SECRETBanco do Brasil OAuth client_secret.obrigatóriasegredo
BB_DEVELOPER_APP_KEYBB Developer App Key (gw-dev-app-key) — appended as a query param on most BB API calls.obrigatóriasegredo
BB_ENVEnvironment: 'sandbox' or 'production'. Defaults to 'sandbox'.opcional
BB_KEY_PATHAbsolute path to the mTLS private key (.key or .pem).opcionalsegredo

Nomes lidos do código do pacote (@codespar/mcp-banco-do-brasil@0.1.0-alpha.5). Descrições e marcações vêm do manifesto dele. Auto-hospedado, você guarda as credenciais.

Primeira chamada democreate_pix_cob

"Create an immediate Pix charge"

tools/callcreate_pix_cobresultado devolvido

Ferramentas

O que o seu agente pode chamar.

13 ferramentas, como o tools/list do pacote as devolve.

create_pix_cob

Create an immediate Pix charge (cob) with QR code. Returns txid, EMV copy-paste payload, and location URL. BACEN Pix v2 standard.

get_pix_cob

Retrieve an immediate Pix charge by its txid.

list_pix_cob

List immediate Pix charges (cob) by date range. Paginated per BACEN Pix v2.

create_pix_devolucao

Refund (devolução) a previously received Pix. Must reference the original endToEndId and a merchant-side refund id.

get_pix_devolucao

Retrieve a Pix devolução by its endToEndId + refund id.

resolve_dict_key

Resolve a DICT key (CPF, CNPJ, email, phone, EVP) to the owner's account data before sending a Pix. Subject to BCB rate limits per consenting payer.

register_dict_key

Register a DICT key on a BB account owned by the merchant. Some key types (email/phone) require BCB confirmation flows.

delete_dict_key

Delete a DICT key owned by the merchant. Irreversible — key becomes available for re-registration after BCB lockout window.

register_boleto

Issue a boleto via BB Cobranças. Returns nosso_numero, linha digitável, barcode, and PDF URL.

get_boleto

Retrieve a boleto by nosso_numero.

cancel_boleto

Cancel (baixa) an outstanding boleto before payment.

get_account_balance

Retrieve the current balance of a BB conta-corrente (checking) account.

Nomes e descrições vêm do tools/list do pacote (@codespar/mcp-banco-do-brasil@0.1.0-alpha.5). Um tipo (leitura, escrita, exclusão) só aparece quando o pacote anota suas ferramentas ou cada ferramenta foi verificada uma a uma; nenhum dos dois existe ainda para este servidor.

Compatibilidade

MCP é um protocolo. Qualquer cliente que o fale pode montar este servidor.

O codespar_discover lista as ferramentas deste servidor, mas conectá-lo exige credenciais que o provedor emite para um operador (certificado, chaves assinadas ou cabeçalhos pareados), que uma chave de teste não produz.

Protocolo

Qualquer cliente MCP

stdio

Perguntas

Antes de instalar.

Como instalo o servidor MCP Banco do Brasil?

Rode npx -y @codespar/mcp-banco-do-brasil@0.1.0-alpha.5 e adicione o bloco de configuração acima ao seu cliente MCP: Claude Code, Cursor, Claude Desktop, VS Code ou qualquer cliente compatível. Sem build, sem SDK.

O que meu agente pode fazer com Banco do Brasil?

Banco do Brasil expõe 13 ferramentas de bancos. Seu agente as chama diretamente; a lista completa está acima.

Como Banco do Brasil autentica, e como as credenciais são guardadas?

Banco do Brasil usa OAuth2. Auto-hospedado, você guarda as credenciais: o servidor as lê das variáveis de ambiente.

Como Banco do Brasil lida com mudanças na API do provedor?

Cada servidor tem versão própria no npm. O comando desta página fixa a 0.1.0-alpha.5, a versão cujas ferramentas estão listadas aqui; seu agente segue nela até você trocar a versão.

Banco do Brasil é open source? Como reporto um bug?

Sim. Banco do Brasil tem licença MIT e está publicado no npm como @codespar/mcp-banco-do-brasil, com o código no GitHub (link no painel Detalhes). Reporte problemas no repositório do pacote; problemas de segurança vão para security@codespar.dev, e respondemos em até 24 horas.

Comece em segundos.

Adicione a configuração acima, defina as variáveis, e seu agente chama as ferramentas.

Comece em segundos demo
Adicione o servidor ao seu cliente com a configuração acima.
Defina as variáveis de ambiente listadas acima.
Peça ao seu agente a primeira chamada.
Banco do Brasil — MCP server · 13 tools | CodeSpar