Projeto

Este repositório contém um servidor Model Context Protocol (MCP) que integra a API da Abacate Pay, uma plataforma de pagamentos. Ele permite que ferramentas baseadas em LLM, como assistentes de IA (por exemplo, Claude, Cursor), interajam diretamente com a Abacate Pay para executar operações financeiras e gerenciar dados de clientes e promoções.

Funcionalidades Principais

• Gerenciar Clientes: Crie e liste clientes com seus dados de contato e fiscais.
• Criar Cobranças: Gere links de pagamento e faturas para seus clientes.
• PIX: Crie QR Codes PIX e verifique seus status.
• Cupons de Desconto: Crie e liste cupons com descontos fixos ou percentuais.
• Simular Pagamentos: Teste o fluxo de pagamento de QR Codes PIX em ambiente de desenvolvimento.

Instalação

Siga estes passos para configurar o servidor localmente:

1. Clone o repositório do GitHub:

   git clone https://github.com/AbacatePay/abacatepay-mcp.git
   

2. Navegue até o diretório do projeto:

   cd abacatepay-mcp
   

3. Instale as dependências do projeto usando npm:

   npm install
   

4. Compile o código TypeScript para JavaScript:

   npm run build
   

   Após a compilação, o arquivo executável estará em 'dist/index.js'.

Configuração do Servidor MCP

Este servidor é projetado para ser iniciado por um cliente MCP (como Claude Desktop ou Cursor) usando o protocolo Stdio. Você precisará adicionar uma entrada na configuração do seu cliente MCP.

A configuração geralmente envolve especificar:

• Um nome único para o servidor (ex: '"abacate-pay"').
• O comando a ser executado para iniciar o servidor. Para este projeto, é o interpretador Node seguido do caminho para o arquivo compilado:
  • 'command': '"node"'
  • 'args': Uma lista contendo o caminho completo para o arquivo 'dist/index.js' dentro do diretório clonado (ex: '["/caminho/completo/para/abacatepay-mcp/dist/index.js"]').
• Variáveis de ambiente necessárias para o servidor, principalmente a chave de API da Abacate Pay:
  • 'env': Um objeto contendo '{"ABACATE_PAY_API_KEY": "sua_chave_de_api_aqui"}'.

Importante:

• Substitua '/caminho/completo/para/abacatepay-mcp/' pelo caminho real onde você clonou o repositório.
• Substitua '"sua_chave_de_api_aqui"' pela sua chave de API obtida no painel da Abacate Pay.

Consulte a documentação do seu cliente MCP (Claude Desktop, Cursor, etc.) para o formato exato do arquivo de configuração (geralmente 'claude_desktop_config.json' ou 'settings.json') e onde adicioná-la.

Obtenção da API Key

1. Acesse o site da Abacate Pay (https://www.abacatepay.com).
2. Vá para a seção Integrar > API Keys.
3. Copie sua chave de API.

Uso Básico

Após configurar e iniciar seu cliente MCP, ele se conectará automaticamente ao servidor Abacate Pay MCP configurado. Você poderá então usar linguagem natural no chat com seu assistente de IA para interagir com a Abacate Pay. Os exemplos abaixo demonstram como os prompts em português podem ser interpretados pelo assistente, que usará as ferramentas fornecidas por este servidor MCP para executar as ações:

• Criar um cliente: "Acabei de fechar um contrato com a empresa TechSolutions LTDA (CNPJ: 12.345.678/0001-90). Pode criar o cadastro deles com o email [email protected] e telefone (11) 3456-7890?"
• Criar uma cobrança: "Preciso gerar um QR Code PIX de R$ 10 para o pagamento da TechSolutions."
• Criar um cupom: "Você pode criar um cupom com 15% de desconto usando o código ALEX15 que vale para até 100 usos?"
• Listar cobranças: "Tive uma cobrança estranha ontem que não reconheço. Você pode buscar todas as cobranças de ontem e me mostrar os detalhes?"

O assistente usará as ferramentas MCP ('createCustomer', 'createPixQrCode', 'createCoupon', 'listBillings', etc.) para processar essas requisições e retornar as informações ou resultados das operações.