{"_id":"@aarintech/baas-mcp","_rev":"20-b53050fe77becfcd560a921876b7c216","name":"@aarintech/baas-mcp","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@aarintech/baas-mcp","version":"1.0.0","keywords":[],"author":{"name":"Aarin Techfin"},"license":"MIT","_id":"@aarintech/baas-mcp@1.0.0","maintainers":[{"name":"yuri_aarin","email":"yuri.valladares@aarin.com.br"},{"name":"laiocarvalho","email":"laio.carvalho@aarin.com.br"},{"name":"thiago_aarin","email":"thiago.nogueira@aarin.com.br"},{"name":"cybersecurity-aarin","email":"cybersecurity@aarin.com.br"},{"name":"cristiano.aarin","email":"cristiano.goncalves@aarin.com.br"}],"bin":{"baas-mcp":"dist/app.js"},"dist":{"shasum":"6ee5f6929fe42716c7936c453197d78f398c4f2f","tarball":"https://registry.npmjs.org/@aarintech/baas-mcp/-/baas-mcp-1.0.0.tgz","fileCount":30,"integrity":"sha512-ytRXd0Arz6ySF+YtSyb54ljnIHWN2muo+rTsy+ehcHKq/jMweFmtaniSmzZQ4iibrryKWlpqj2HqKpCF5k60Yg==","signatures":[{"sig":"MEQCIFXFBVI2QY3L8MwMyJkIwWSSmVQowyZFoCoqKIOWHD5xAiA7lxxjxFahfiH0igx+kODvOYrVmWM8VyFt4zxHDGOeBw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":60630},"main":"dist/app.js","type":"module","gitHead":"5edb2fe4fb875f4cf8db8edec218d2ea4e5a7d53","scripts":{"dev":"npm run build && npm link","lint":"eslint \"{src,apps,libs,test}/**/*.ts\" --fix","build":"tsc","format":"prettier --write \"src/**/*.ts\"","lint:check":"eslint \"{src,apps,libs,test}/**/*.ts\"","format:check":"prettier --check \"src/**/*.ts\""},"_npmUser":{"name":"thiago_aarin","email":"thiago.nogueira@aarin.com.br"},"_npmVersion":"10.9.4","description":"Projeto de utilização do BaaS via MCP Localmente","directories":{},"_nodeVersion":"22.21.1","dependencies":{"zod":"^3.25.67","pino":"^9.14.0","express":"^4.17.1","jwt-decode":"^4.0.0","node-fetch":"^3.3.2","pino-pretty":"^13.1.2","jsonwebtoken":"^9.0.2","@modelcontextprotocol/sdk":"^1.21.0"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.20.3","eslint":"^9.29.0","globals":"^16.2.0","prettier":"^3.6.2","@eslint/js":"^9.29.0","typescript":"^5.8.3","@types/node":"^24.0.15","@types/express":"^4.17.1","typescript-eslint":"^8.35.0","@types/jsonwebtoken":"^9.0.10","eslint-config-prettier":"^10.1.5","eslint-plugin-prettier":"^5.5.1"},"_npmOperationalInternal":{"tmp":"tmp/baas-mcp_1.0.0_1762778360223_0.9144647329464353","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@aarintech/baas-mcp","version":"1.0.1","keywords":[],"author":{"name":"Aarin Techfin"},"license":"MIT","_id":"@aarintech/baas-mcp@1.0.1","maintainers":[{"name":"yuri_aarin","email":"yuri.valladares@aarin.com.br"}],"bin":{"baas-mcp":"dist/app.js"},"dist":{"shasum":"ebd1c61f17205e3a794072b3c9f7b429569caed7","tarball":"https://registry.npmjs.org/@aarintech/baas-mcp/-/baas-mcp-1.0.1.tgz","fileCount":30,"integrity":"sha512-pE0g/v4worQIoOiR/gQpdw19PuI9O4mpfNjV7HJ/9//ViwFu4g9aznWddG73BDNZq9Q0qkH98lLs4U7LRXzsbQ==","signatures":[{"sig":"MEUCIQDekn2rsczCR4nuhK/xwIm8lWzAebSr4pEUeYF8DqUiXgIgPJTmiEmsf9noRhIxwQhBLy49C6pJ6YSopuE9w6J3EUo=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":63086},"main":"dist/app.js","type":"module","gitHead":"de95159fd6c7db5263ecec1024e39e0a8dc96344","scripts":{"dev":"npm run build && npm link","lint":"eslint \"{src,apps,libs,test}/**/*.ts\" --fix","build":"tsc","format":"prettier --write \"src/**/*.ts\"","lint:check":"eslint \"{src,apps,libs,test}/**/*.ts\"","format:check":"prettier --check \"src/**/*.ts\""},"_npmUser":{"name":"yuri_aarin","email":"yuri.valladares@aarin.com.br"},"_npmVersion":"10.9.4","description":"Projeto de utilização do BaaS via MCP Localmente","directories":{},"_nodeVersion":"22.21.1","dependencies":{"zod":"^3.25.67","pino":"^9.14.0","express":"^4.17.1","jwt-decode":"^4.0.0","node-fetch":"^3.3.2","pino-pretty":"^13.1.2","jsonwebtoken":"^9.0.2","@modelcontextprotocol/sdk":"^1.21.0"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.20.3","eslint":"^9.29.0","globals":"^16.2.0","prettier":"^3.6.2","@eslint/js":"^9.29.0","typescript":"^5.8.3","@types/node":"^24.0.15","@types/express":"^4.17.1","typescript-eslint":"^8.35.0","@types/jsonwebtoken":"^9.0.10","eslint-config-prettier":"^10.1.5","eslint-plugin-prettier":"^5.5.1"},"_npmOperationalInternal":{"tmp":"tmp/baas-mcp_1.0.1_1763574743678_0.10161776399214584","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2025-11-05T16:07:44.735Z","modified":"2026-08-04T14:37:31.191Z","0.5.0":"2025-11-05T16:07:44.928Z","0.5.1":"2025-11-05T17:01:35.963Z","0.5.2":"2025-11-05T18:51:21.916Z","0.5.4-beta.0":"2025-11-06T13:54:01.501Z","0.5.3":"2025-11-06T14:05:33.920Z","0.5.4":"2025-11-06T14:41:14.051Z","0.5.5-beta.1":"2025-11-06T16:27:14.455Z","1.0.0":"2025-11-10T12:39:20.400Z","1.0.1":"2025-11-19T17:52:23.860Z"},"author":{"name":"Aarin Techfin"},"license":"MIT","keywords":[],"description":"Projeto de utilização do BaaS via MCP Localmente","maintainers":[{"email":"yuri.valladares@aarin.com.br","name":"yuri_aarin"},{"email":"fabricio.nascimento@aarin.com.br","name":"aarin_fabricio_nascimento"}],"readme":"# BaaS MCP (Model Context Protocol)\n## Introdução\n\nO BaaS MCP é uma interface alternativa ao uso de APIs REST, permitindo que Agentes de IA (como ChatGPT, Gemini, Claude e outros) interajam diretamente com o Banking as a Service da Aarin por meio do protocolo MCP (Model Context Protocol).\n\nO protocolo MCP permite que agentes de IA tenham acesso a ferramentas, que executam ações em sistemas externos ao modelo (como criar boletos, consultar extratos, gerar cobranças Pix) a partir de prompts escritos em linguagem natural. Isso reduz o tempo de integração e simplifica o onboarding de parceiros.\n\n\n## Pré-requisitos\n\nPara utilizar o BaaS MCP, é necessário ter:\n\n Credenciais de acesso ao BaaS da Aarin e certificado para conexão mTLS;\n Um agente de IA com suporte ao protocolo MCP;\n Conhecimento básico de como criar prompts estruturados.\n Node.js instalado com a versão 22 ou superior.\n\n\n## Como configurar o MCP Server\n\nAntes de iniciar a configuração, é importante entender que o MCP Server é o componente que conecta o agente de IA ao BaaS da Aarin e é executado na infraestrutura do cliente.\n\nAbaixo estão os passos para configurar o MCP Server e estabelecer essa conexão de forma segura e funcional.\n\n### Dados necessários:\n\n Pacote NPM do MCP Server: @aarintech/baas-mcp\n Variáveis de ambiente:\n BAAS_USERNAME: Credencial de acesso ao BaaS\n BAAS_PASSWORD: Credencial de acesso ao BaaS\n BAAS_API_URL: Host que define o ambiente do BaaS, podendo ser https://baas-sandbox.aarin.dev (Ambiente de homologação) ou https://baas.aarin.com.br (Ambiente produtivo)\n MTLS_PUBLIC_CERT: Certificado assinado para validação mTLS\n MTLS_PRIVATE_KEY: Chave privada para validação mTLS\n LOG_LEVEL: Variável opcional para configurar log do MCP Server\n\nPrimeiramente instale o pacote do Bass MCP:\n```bash\n npm install -g @aarintech/baas-mcp\n```\n\nEm seguida configure o acesso ao Baas MCP como no exemplo abaixo:\n```json\n{\n \"mcpServers\": {\n \"aarinBaaS\": {\n \"command\": \"npx\",\n \"type\": \"stdio\",\n \"args\": [\n \"-y\",\n \"@aarintech/baas-mcp\"\n ],\n \"env\": {\n \"BAAS_USERNAME\": \"your_username\",\n \"BAAS_PASSWORD\": \"your_password\",\n \"BAAS_API_URL\": \"https://baas-sandbox.aarin.dev\",\n \"MTLS_PUBLIC_CERT\": \"-----BEGIN CERTIFICATE----- -----END CERTIFICATE-----\",\n \"MTLS_PRIVATE_KEY\": \"-----BEGIN PRIVATE KEY----- -----END PRIVATE KEY-----\",\n \"LOG_LEVEL\": \"debug\"\n }\n }\n }\n}\n```\n\n## Ferramentas Disponíveis (MCP Tools)\n\nApós conectar um agente ao BaaS MCP, é possível explorar as ferramentas que permitem criar, consultar e gerenciar informações financeiras no ecossistema da Aarin. Tudo isso via linguagem natural.\n\nEssas ferramentas funcionam de forma integrada: com um único prompt, o agente pode consultar uma conta, criar uma cobrança Pix e acompanhar o status dessa cobrança.\n\nO verdadeiro poder do MCP está em combinar múltiplas ferramentas dentro de uma mesma interação.\n\nAbaixo está uma listagem das funcionalidades habilitadas para uso nesse momento.\n\n### Contas\n| Tool MCP | Descrição | Exemplos de Prompt para uso |\n| ---------------- | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\n| ConsultarConta | Recupera dados cadastrais e informações básicas de uma conta. | • “Mostre os dados cadastrais da conta cd8ed314-dcf0-4eb1-b9d2-b515078dad68” • “Quais informações estão registradas na conta do CPF 123.456.789-00?” |\n| ConsultarSaldo | Exibe o saldo atual disponível de uma conta. | • “Qual é o saldo da conta cd8ed314-dcf0-4eb1-b9d2-b515078dad68?” • “Quanto tem disponível na conta 1234?” |\n| ConsultarExtrato | Lista as últimas transações realizadas em uma conta, com filtro opcional por número de dias. | • “Mostre as movimentações dos últimos 7 dias da conta 9876” • “Liste as transações do mês passado da conta de CPF 123.456.789-00” |\n\n### Pix\n| Tool MCP | Descrição | Exemplo de Prompt |\n| -------------------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| ConsultarChaveDICT | Busca informações de uma chave Pix (CPF, CNPJ, e-mail ou telefone) diretamente no DICT. | • “Verifique a quem pertence a chave Pix 123.456.789-00” • “Qual é o tipo da chave Pix cnpj@empresa.com.br?” |\n| CriarCobrancaPix | Cria uma cobrança Pix com valor, vencimento e mensagem personalizados, retornando o QR Code. | • “Crie uma cobrança Pix de R$150,00 com vencimento em 5 dias para o CPF 123.456.789-00” • “Gere um QR Code Pix de R$200,00 com a mensagem ‘mensalidade novembro’” |\n| ConsultarCobrancaPix | Retorna o status atual de uma cobrança Pix (pendente, paga, vencida etc.). | • “A cobrança Pix com ID aZ9vL2kQmT5rXb1YwN8eJcHdUs foi paga?” • “Verifique o status da cobrança Pix gerada ontem” |\n\n### Boletos\n| Tool MCP | Descrição | Exemplo de Prompt |\n| --------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| CriarBoleto | Emite um boleto bancário com valor, vencimento, pagador e mensagem definidos, retornando linha digitável e instruções de pagamento. | • “Crie um boleto de R$350,00 com vencimento em 10 dias para o CPF 123.456.789-00” • “Gere um boleto para pagamento de R$500,00 com a mensagem ‘mensalidade de novembro’” |\n| ConsultarBoleto | Consulta o status e os dados bancários associados a um boleto previamente criado. | • “Qual o status do boleto ID 89f7a1f0-cb3d-4f22-b7a1-9d1a2b7d5e91?”• “O boleto do CPF 123.456.789-00 já foi pago?” |\n\n---\n\n\n## 💡 Combinando ferramentas\nAs ferramentas MCP podem ser usadas em conjunto dentro de um mesmo prompt. Por exemplo:\n\n- “Liste as contas com saldo acima de R$1.000,00 e crie uma cobrança Pix de 10% desse valor para cada uma;”\n \n- “Consulte a conta do CPF 123.456.789-00 e gere um boleto de R$200,00 com vencimento para amanhã;”\n\n- “Verifique o saldo da conta 1234, crie uma cobrança Pix e me envie o QR Code para pagamento.”\n\n\n## Glossário do MCP\n| Termo | Definição |\n| ----------------- | ------------------------------------------------------------------------------------------ |\n| MCP | Model Context Protocol – protocolo que permite que agentes de IA interajam com APIs. |\n| LLM | Large Language Model – modelo de IA que interpreta linguagem natural (ex: GPT-4). |\n| Tool MCP | “Ferramenta” definida no protocolo MCP que executa uma ação concreta. |\n| Agente de IA | Interface que usa LLMs + ferramentas + base de conhecimento. |\n| Prompt | Comando textual dado pelo usuário para a IA executar os comandos. |\n| Linguagem natural | Linguagem comum humana conversacional, sem a complexidade de uma linguagem de programação. |\n\n## FAQ (Perguntas Frequentes)\n\nPreciso saber escrever código para usar o BaaS MCP?\n\n Não, basta ter as credenciais do Baas e conectar o agente ao MCP Server para iniciar o uso.\n\nA LLM consegue usar dados de uma operação anterior?\n\n Sim. O contexto da conversa é mantido, e ela consegue encadear ações com base em histórico.\n\nO que acontece se eu encontrar algum erro quando usar o MCP?\n\n A LLM pode tentar corrigir automaticamente, usar um caminho alternativo ou avisar que houve falha.\n\nEstou com problemas ao configurar o MCP Server, o que eu faço?\n\n Verifique se seu agente de IA suporta uso de ferramentas por meio de MCP, através do método de comunicação STDIO. Verifique também se as credenciais do BaaS e o certificado mTLS estão válidos.\n\nQual a LLM/Agente IA que devo usar?\n\n A escolha e configuração do agente IA é de responsabilidade do cliente, mas recomendamos o uso de LLMs que tenham ao menos dois níveis de proteção de dados.\n","readmeFilename":"README.md"}