Projeto Overview

Este projeto é um servidor MCP (Model Context Protocol) que permite que modelos de linguagem (como o Claude) interajam com o WhatsApp através da Evolution API. Ele atua como um backend que traduz solicitações do LLM em chamadas para a API do WhatsApp, provendo contexto e funcionalidade de comunicação.

Principais Funcionalidades

• Gerenciamento de Instâncias: Permite criar, listar e verificar o status de instâncias do WhatsApp na Evolution API.
• Conexão de Contas: Fornece o QR Code necessário para conectar uma conta WhatsApp a uma instância.
• Envio de Mensagens: Habilita o envio de mensagens de texto para contatos do WhatsApp através de uma instância conectada.

Passos de Instalação

1. Clone o repositório do GitHub:

   git clone https://github.com/genera-ai/mcp-evolution-api.git
   cd mcp-evolution-api
   

2. Instale as dependências do projeto usando npm ou yarn:

   npm install
   # ou
   yarn install
   

3. Crie um arquivo chamado '.env' na raiz do projeto e configure suas credenciais da Evolution API e a porta para o servidor MCP:

   EVOLUTION_API_URL=seu_url_da_evolution_api # Ex: https://your-evolution-api-server.com
   EVOLUTION_API_KEY=sua_chave_api # Sua chave de API da Evolution API
   PORT=3000 # Porta que o servidor MCP irá escutar (pode ser outra)
   

   Substitua os valores pelos seus dados reais.
4. Certifique-se de que a Evolution API esteja instalada e rodando separadamente ou configurada via Docker Compose conforme descrito na documentação do repositório.
5. Inicie o servidor MCP:

   npm start # Para rodar em modo de produção
   # ou
   npm run dev # Para rodar em modo de desenvolvimento
   

Configuração do Servidor para Clientes MCP

Para que um cliente MCP (como o Claude Desktop ou outra aplicação compatível) possa utilizar este servidor, ele precisa ser configurado no cliente. A configuração mínima geralmente inclui o nome do servidor MCP e a forma como o cliente deve se conectar a ele (via URL ou executando um comando).

• Configuração via URL: Se o servidor MCP estiver rodando como um processo separado e acessível por uma URL (por exemplo, 'http://localhost:3000'), a configuração no arquivo do cliente MCP seria similar a:

  {
    // ... outras configurações do cliente ...
    "mcpServers": {
      "nome-servidor-whatsapp": { // Um nome único para este servidor no seu cliente
        "url": "http://localhost:3000" // O endereço completo (URL e porta) onde o servidor MCP está rodando
        // Dependendo do cliente, outras opções como autenticação podem ser adicionadas aqui
      }
    }
    // ... outras configurações do cliente ...
  }
  

  Ajuste o 'nome-servidor-whatsapp' e a 'url' conforme necessário.

• Configuração via Comando: Se você preferir que o cliente MCP inicie este servidor como um subprocesso, a configuração seria similar a:

  {
    // ... outras configurações do cliente ...
    "mcpServers": {
      "nome-servidor-whatsapp": { // Um nome único para este servidor no seu cliente
        "command": "node", // O comando executável para iniciar o script
        "args": [
          "/caminho/completo/para/seu/mcp-evolution-api/dist/main.js" // O caminho absoluto para o arquivo principal do servidor compilado
          // Argumentos adicionais podem ser passados, se o servidor os aceitar
        ]
        // O ambiente (.env) deve estar acessível onde o comando é executado.
      }
    }
    // ... outras configurações do cliente ...
  }
  

  Ajuste o 'nome-servidor-whatsapp' e o caminho no array 'args' conforme a localização do seu projeto.

Uso Básico com LLM

Após configurar o servidor MCP no seu cliente compatível, o modelo de linguagem ganhará a capacidade de interagir com o WhatsApp. Você poderá dar instruções em linguagem natural para o modelo executar as ferramentas disponíveis no servidor, como por exemplo:

• "Por favor, liste todas as minhas instâncias do WhatsApp."
• "Crie uma nova instância do WhatsApp chamada 'minha_empresa'."
• "Quero o QR code para conectar a instância 'minha_empresa'."
• "Envie a mensagem 'Olá, tudo bem?' para o número 5511987654321 usando a instância 'minha_empresa'."

O cliente MCP e o LLM interpretarão sua solicitação e chamarão as ferramentas apropriadas no servidor MCP para realizar a ação.