mmmarcelom/local-mcp-server

CRM MCP Server

Um servidor MCP (Model Context Protocol) para integração com APIs de CRM. Este servidor permite que modelos de IA acessem e manipulem dados do seu CRM através de ferramentas padronizadas.

Funcionalidades

• Gestão de Contatos: Listar, criar e atualizar contatos (sem exclusão)
• Gestão de Cards: Gerenciar cards do sistema
• Envio de Mensagens: Enviar mensagens através de diferentes canais
• Busca: Pesquisar em diferentes entidades do CRM

Instalação

1. Clone o repositório:

git clone <seu-repositorio>
cd local-mcp-server

2. Instale as dependências:

npm install

3. Configure as variáveis de ambiente:

cp env.example .env

Edite o arquivo .env com suas configurações:

# Configurações do CRM
CRM_API_URL=https://api.seucrm.com
CRM_API_KEY=sua_api_key_aqui
CRM_API_SECRET=sua_api_secret_aqui

# Configurações de autenticação (opcional)
CRM_USERNAME=seu_usuario
CRM_PASSWORD=sua_senha

Uso

Desenvolvimento

npm run dev

Produção

npm run build
npm start

Ferramentas Disponíveis

Contatos

• crm_get_contacts - Lista todos os contatos
• crm_get_contact - Obtém um contato específico
• crm_create_contact - Cria um novo contato
• crm_update_contact - Atualiza um contato

Cards

• crm_get_cards - Lista todos os cards
• crm_get_card - Obtém um card específico
• crm_create_card - Cria um novo card
• crm_update_card - Atualiza um card

Mensagens

• crm_send_message - Envia uma mensagem através do CRM

Utilitários

• crm_search - Busca por entidades

Exemplos de Uso

Criar um Contato

{
  "name": "crm_create_contact",
  "arguments": {
    "name": "João Silva",
    "email": "joao@exemplo.com",
    "phone": "+55 11 99999-9999",
    "company": "Empresa ABC",
    "position": "Gerente"
  }
}

Criar um Card

{
  "name": "crm_create_card",
  "arguments": {
    "title": "Reunião com Cliente",
    "description": "Discussão sobre proposta comercial",
    "contact_id": "contact_123",
    "status": "pending"
  }
}

Enviar Mensagem

{
  "name": "crm_send_message",
  "arguments": {
    "message": "Olá! Gostaria de agendar uma reunião.",
    "to": "joao@exemplo.com",
    "from": "vendas@empresa.com",
    "subject": "Agendamento de Reunião",
    "channel": "email"
  }
}

Configuração do Cliente MCP

Para usar este servidor com um cliente MCP, adicione a seguinte configuração:

{
  "mcpServers": {
    "crm": {
      "command": "node",
      "args": ["dist/index.js"],
      "env": {
        "CRM_API_URL": "https://api.seucrm.com",
        "CRM_API_KEY": "sua_api_key",
        "CRM_API_SECRET": "sua_api_secret"
      }
    }
  }
}

Estrutura do Projeto

src/
├── index.ts              # Ponto de entrada do servidor
├── types/
│   └── crm.ts           # Tipos TypeScript para entidades do CRM
├── services/
│   └── crm-api.ts       # Serviço de comunicação com a API do CRM
├── resources/
│   └── crm.ts           # Recursos MCP para o CRM
└── tools.json           # Definição das ferramentas disponíveis

Personalização

Para adaptar este servidor para seu CRM específico:

1. Modifique os tipos em src/types/crm.ts para corresponder à estrutura da sua API
2. Ajuste os endpoints em src/services/crm-api.ts para corresponder à sua API
3. Atualize os recursos em src/resources/crm.ts para incluir as ferramentas específicas do seu CRM
4. Configure as variáveis de ambiente com suas credenciais do CRM

Contribuição

1. Faça um fork do projeto
2. Crie uma branch para sua feature (git checkout -b feature/nova-feature)
3. Commit suas mudanças (git commit -am 'Adiciona nova feature')
4. Push para a branch (git push origin feature/nova-feature)
5. Abra um Pull Request

Licença

MIT License - veja o arquivo LICENSE para detalhes.