Skip to content

derikfernandes/bcb-meios-pagamento-mcp

Repository files navigation

Servidor MCP - Dados Abertos de Meios de Pagamento do BCB

Servidor MCP (Model Context Protocol) para acessar os dados abertos de meios de pagamento do Banco Central do Brasil através de LLMs como Claude, ChatGPT e outros.

📋 Descrição

Este servidor MCP fornece acesso programático à API de Dados Abertos de Meios de Pagamento do Banco Central do Brasil, permitindo que assistentes de IA consultem informações sobre:

  • 💳 Transações com cartões de pagamento
  • 📊 Dados mensais e trimestrais de meios de pagamento
  • 🏪 Estabelecimentos credenciados
  • 💰 Taxas de intercâmbio e desconto
  • 🏧 Estatísticas de terminais ATM
  • 👥 Informações sobre portadores de cartão
  • 📱 Dados sobre PIX, TED, DOC, boletos e outros

🚀 Instalação

# Clone o repositório
git clone https://github.com/derikfernandes/bcb-meios-pagamento-mcp.git
cd bcb-meios-pagamento-mcp

# Instale as dependências
npm install

# Compile o TypeScript
npm run build

🔧 Configuração

Este servidor oferece duas formas de uso:

Opção 1: Claude Desktop (Uso Local)

Para uso local com Claude Desktop, adicione ao arquivo de configuração (~/Library/Application Support/Claude/claude_desktop_config.json no macOS ou %APPDATA%/Claude/claude_desktop_config.json no Windows):

{
  "mcpServers": {
    "bcb-meios-pagamento": {
      "command": "node",
      "args": ["/caminho/completo/para/bcb-meios-de-pagamentos/dist/index.js"]
    }
  }
}

Opção 2: ChatGPT (Servidor Remoto)

ChatGPT requer que o servidor esteja hospedado com HTTPS. Siga estas etapas:

Passo 1: Deploy do Servidor

Escolha uma opção de deployment:

Opção A - Render (Recomendado - Free Tier)

  1. Crie uma conta em render.com
  2. Conecte seu repositório GitHub
  3. Use as configurações do arquivo render.yaml incluído
  4. Seu servidor estará disponível em https://seu-app.onrender.com

Opção B - Railway

  1. Crie uma conta em railway.app
  2. Faça deploy do repositório
  3. Use as configurações do arquivo railway.json incluído
  4. Seu servidor estará disponível em https://seu-app.railway.app

Opção C - ngrok (Desenvolvimento Local)

# Terminal 1: Inicie o servidor HTTP
npm run dev:http

# Terminal 2: Exponha via ngrok
ngrok http 3000

Consulte DEPLOYMENT.md para guia completo de deployment.

Passo 2: Configurar no ChatGPT/GPT Builder

Para ChatGPT (SSE):

  1. Acesse ChatGPT com assinatura Pro, Plus, Team, Education ou Enterprise

  2. Ative o Developer Mode

  3. Adicione um novo MCP Server:

    • Nome: BCB Meios de Pagamento
    • URL SSE: https://seu-servidor.com/sse
    • Tipo: Server-Sent Events (SSE)
  4. Teste perguntando: "Quais foram os dados de PIX em dezembro de 2023?"

Para GPT Builder (REST API):

  1. Faça o deploy do servidor no Render (ou outro provedor)

  2. Acesse o GPT Builder

  3. Configure um servidor MCP com uma das seguintes opções:

    Opção A - Endpoint Principal:

    • URL Base: https://seu-servidor.onrender.com
    • Endpoint de Ferramentas: /tools
    • Endpoint de Execução: /tools/call

    Opção B - Endpoint com Nome do Servidor:

    • URL Base: https://seu-servidor.onrender.com
    • Endpoint de Ferramentas: /bcb_mcp/tools
    • Endpoint de Execução: /bcb_mcp/tools/call

    Opção C - Endpoint MCP v1:

    • URL Base: https://seu-servidor.onrender.com
    • Endpoint de Ferramentas: /mcp/v1/tools
    • Endpoint de Execução: /mcp/v1/tools/call
  4. O GPT Builder irá automaticamente descobrir as ferramentas através do endpoint configurado

  5. Teste perguntando: "Quais foram os dados de PIX em dezembro de 2023?"

Endpoints Disponíveis:

  • GET /health - Verifica se o servidor está online
  • GET /discover - Lista todos os endpoints disponíveis
  • GET /tools - Lista todas as ferramentas (também aceita POST)
  • POST /tools/call - Executa uma ferramenta
  • GET /bcb_mcp/tools - Lista ferramentas (formato com nome do servidor)
  • POST /bcb_mcp/tools/call - Executa ferramenta (formato com nome do servidor)
  • GET /mcp/v1/tools - Lista ferramentas (protocolo MCP v1)
  • POST /mcp/v1/tools/call - Executa ferramenta (protocolo MCP v1)
  • GET /mcp - Retorna informações do servidor MCP
  • GET /mcp/manifest - Retorna manifesto MCP
  • GET /.well-known/mcp - Manifesto MCP (padrão)

Nota: Se você receber o erro "Unable to load tools" ou "Error retrieving tool list from MCP server", consulte o guia DEBUG_MCP.md para solução de problemas.

Opção 3: Outros LLMs

Este servidor segue o protocolo MCP padrão e é compatível com qualquer LLM que suporte:

  • Modo Local: Protocolo stdio (como Claude Desktop)
  • Modo Remoto: Protocolo SSE via HTTP/HTTPS (como ChatGPT)

🛠️ Ferramentas Disponíveis

1. consultar_meios_pagamento_mensal

Consulta dados mensais sobre meios de pagamento (PIX, TED, DOC, boletos, etc.).

Parâmetros:

  • ano_mes (obrigatório): Formato YYYYMM (ex: "202312")
  • top (opcional): Número máximo de registros
  • skip (opcional): Paginação
  • filtro (opcional): Filtro OData

Exemplo:

Consulte os dados de meios de pagamento para dezembro de 2023

2. consultar_meios_pagamento_trimestral

Consulta dados trimestrais de cartões e transferências.

Parâmetros:

  • trimestre (obrigatório): Formato YYYYQ (ex: "20234")
  • top (opcional): Número máximo de registros
  • skip (opcional): Paginação
  • filtro (opcional): Filtro OData

Exemplo:

Mostre os dados trimestrais do 4º trimestre de 2023

3. consultar_transacoes_cartoes

Consulta estoque e transações de cartões.

Parâmetros:

  • trimestre (obrigatório): Formato YYYYQ
  • top (opcional): Número máximo de registros
  • ordenar_por (opcional): Campo para ordenação
  • filtro (opcional): Filtro OData

4. consultar_estabelecimentos_credenciados

Consulta quantidade de estabelecimentos credenciados.

Parâmetros:

  • trimestre (obrigatório): Formato YYYYQ
  • top (opcional): Número máximo de registros
  • ordenar_por (opcional): Campo para ordenação
  • filtro (opcional): Filtro OData

5. consultar_taxas_intercambio

Consulta taxas de intercâmbio do mercado.

Parâmetros:

  • trimestre (obrigatório): Formato YYYYQ
  • top (opcional): Número máximo de registros
  • filtro (opcional): Filtro OData

6. consultar_taxas_desconto

Consulta taxas de desconto cobradas de estabelecimentos.

Parâmetros:

  • trimestre (obrigatório): Formato YYYYQ
  • top (opcional): Número máximo de registros
  • filtro (opcional): Filtro OData

7. consultar_terminais_atm

Consulta estatísticas sobre terminais ATM.

Parâmetros:

  • trimestre (obrigatório): Formato YYYYQ
  • top (opcional): Número máximo de registros
  • filtro (opcional): Filtro OData

8. consultar_portadores_cartao

Consulta informações sobre portadores de cartão.

Parâmetros:

  • trimestre (obrigatório): Formato YYYYQ
  • top (opcional): Número máximo de registros
  • filtro (opcional): Filtro OData

📖 Exemplos de Uso

Após configurar o servidor, você pode fazer perguntas naturais ao seu assistente de IA:

Quais foram os dados de PIX em dezembro de 2023?

Mostre as transações com cartões no último trimestre de 2023

Quantos estabelecimentos estavam credenciados no 3º trimestre de 2023?

Quais são as taxas de intercâmbio atuais?

🔍 Filtros OData

Você pode usar filtros OData para refinar suas consultas:

Modalidade eq 'PIX'
Trimestre eq '20234'
Valor gt 1000000

Operadores suportados:

  • eq: igual
  • ne: diferente
  • gt: maior que
  • ge: maior ou igual
  • lt: menor que
  • le: menor ou igual
  • and: e lógico
  • or: ou lógico

🔗 API do Banco Central

Este servidor utiliza a API oficial de Dados Abertos do Banco Central do Brasil: https://olinda.bcb.gov.br/olinda/servico/MPV_DadosAbertos/versao/v1/swagger-ui3

📄 Licença

MIT

🤝 Contribuindo

Contribuições são bem-vindas! Sinta-se à vontade para abrir issues e pull requests.

📧 Contato

Para dúvidas ou sugestões, abra uma issue no GitHub: https://github.com/derikfernandes/bcb-meios-pagamento-mcp/issues

🌐 Repositório

📚 Documentação Adicional

🔍 Testando o Servidor

Após fazer o deploy, você pode testar o servidor acessando:

# Health check
curl https://seu-servidor.onrender.com/health

# Listar ferramentas
curl https://seu-servidor.onrender.com/tools

# Descobrir endpoints disponíveis
curl https://seu-servidor.onrender.com/discover

# Testar endpoint com nome do servidor
curl https://seu-servidor.onrender.com/bcb_mcp/tools

🐛 Solução de Problemas

Se você encontrar problemas ao conectar o servidor:

  1. Verifique os logs do servidor - O servidor registra todas as requisições
  2. Teste os endpoints manualmente - Use curl para testar cada endpoint
  3. Acesse /discover - Veja todos os endpoints disponíveis
  4. Consulte DEBUG_MCP.md - Guia completo de solução de problemas

🔄 Atualizações

  • v1.0.0 (2024): Versão inicial com 8 ferramentas principais
  • v1.1.0 (2025): Adicionado suporte para ChatGPT via HTTP/SSE
  • v1.2.0 (2025): Adicionados múltiplos endpoints REST para compatibilidade com GPT Builder
    • Suporte para /bcb_mcp/tools e /bcb-mcp/tools
    • Endpoints MCP v1 (/mcp/v1/tools)
    • Endpoint de descoberta (/discover)
    • Middleware de logging para debug
    • Suporte completo para CORS preflight

About

Servidor MCP para acessar dados abertos de meios de pagamento do Banco Central do Brasil através de LLMs como Claude, ChatGPT e outros

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors