CLI e editores

O Customermates é o CRM de código aberto pensado para a IA. Depois de conectado, o seu agente de programação lê e grava contatos, negócios e notas sem sair do terminal. Todos os clientes descritos aqui se autenticam do mesmo jeito: uma chave de API no cabeçalho x-api-key para <BASE_URL>/api/v1/mcp, em que <BASE_URL> é o endereço pelo qual você abre o Customermates, na nuvem ou na sua própria instância. Os trechos abaixo já trazem o endereço do site que exibe esta página; se você abre o Customermates em outro endereço, troque-o além de YOUR_KEY.

Crie uma chave de API

No Customermates, abra Chaves de API e conectores, clique em Adicionar e escolha Chave de API padrão. Dê a ela o nome do cliente (por exemplo Claude Code); sem uma data em Expira em, ela nunca expira. A chave de 64 caracteres aparece uma única vez, então copie-a na hora. Conexões rápidas, na mesma janela, faz isso por você: dá à chave o nome do cliente, define que ela expira em 365 dias e mostra o trecho de configuração com a chave já preenchida e a data de expiração logo abaixo.

Criar uma chave exige Criar na linha API e webhooks da sua função, e a própria página exige Acesso de leitura Todos nessa linha; a função integrada Administrador tem as duas coisas. Uma chave herda as permissões do usuário que a criou; não há escopo por chave. Crie uma chave por cliente para poder revogar uma sem mexer nas outras; o registro de atividades anota o usuário a quem a chave pertence, não a chave em si. Chaves de API e MCP funcionam em todos os planos e em instâncias com hospedagem própria. Detalhes: Chaves de API.

Claude Code

O Claude Code adiciona servidores MCP pela própria CLI. Um único comando faz a configuração. Execute-o em qualquer terminal, trocando YOUR_KEY:

claude mcp add --transport http customermates https://customermates.com/api/v1/mcp \
  --header "x-api-key: YOUR_KEY"

Não é preciso reiniciar nem editar nenhum arquivo de configuração. O Claude Code se conecta automaticamente. Execute claude mcp list para confirmar que customermates aparece.

Escopo: por padrão, o comando usa o escopo local. Adicione --scope user para deixar o Customermates disponível em todo o seu computador, ou --scope project para gravá-lo no .mcp.json de um repositório e a sua equipe receber a configuração.

Codex

O Codex se conecta diretamente ao Customermates por Streamable HTTP. codex mcp add customermates --url <BASE_URL>/api/v1/mcp adiciona a URL do servidor, mas o comando da CLI não tem opção para um cabeçalho x-api-key personalizado. Para acessar com chave de API, abra ~/.codex/config.toml (crie o arquivo se ele não existir) e adicione o bloco completo abaixo, trocando YOUR_KEY:

[mcp_servers.customermates]
enabled = true
url = "https://customermates.com/api/v1/mcp"
http_headers = { "x-api-key" = "YOUR_KEY" }

Para pegar a chave do seu ambiente em vez de guardá-la no arquivo, troque a linha http_headers do bloco acima por:

env_http_headers = { "x-api-key" = "CUSTOMERMATES_API_KEY" }

Depois, exporte CUSTOMERMATES_API_KEY no perfil do seu shell. As novas sessões reconhecem o servidor, então encerre a atual e comece uma nova.

O mesmo endpoint HTTP também aceita OAuth. Se você prefere entrar com login, adicione a URL com codex mcp add customermates --url <BASE_URL>/api/v1/mcp e depois execute codex mcp login customermates. A ponte stdio descrita mais abaixo é para clientes do Claude Desktop que precisam dela.

Cursor

Para configurar o Cursor, abra Settings → Tools & MCP → Add new MCP server e cole isto, trocando YOUR_KEY:

{
  "customermates": {
    "url": "https://customermates.com/api/v1/mcp",
    "headers": {
      "x-api-key": "YOUR_KEY"
    }
  }
}

O Cursor recarrega a configuração automaticamente, então não é preciso reiniciar. As ferramentas aparecem no Composer na hora. Para editar o arquivo diretamente, o mesmo bloco vai em ~/.cursor/mcp.json (global) ou em <project>/.cursor/mcp.json (por projeto), dentro de mcpServers.

Gemini CLI

O Gemini CLI carrega os servidores MCP de ~/.gemini/settings.json. Mescle isto ao seu arquivo, trocando YOUR_KEY:

{
  "mcpServers": {
    "customermates": {
      "httpUrl": "https://customermates.com/api/v1/mcp",
      "headers": {
        "x-api-key": "YOUR_KEY"
      }
    }
  }
}

Se mcpServers já tiver entradas, adicione customermates ao lado das existentes em vez de sobrescrever o objeto.

Claude Desktop (arquivo de configuração)

O caminho recomendado para o Claude Desktop é o caminho do conector: OAuth, sem chave, sincronizado entre os seus dispositivos. Em um plano gratuito, ou se você prefere uma chave estática, o arquivo de configuração abaixo também funciona.

Abra Claude → Settings → Developer → Edit Config, ou o arquivo diretamente:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json

Mescle isto ao seu arquivo, trocando YOUR_KEY:

{
  "mcpServers": {
    "customermates": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://customermates.com/api/v1/mcp",
        "--header",
        "x-api-key:YOUR_KEY"
      ]
    }
  }
}

O mcp-remote é um adaptador que permite ao Claude Desktop conversar com um servidor MCP HTTP remoto por stdio. Ele é baixado na primeira execução pelo npx, então você precisa do Node 18+ no PATH.

Depois, reinicie: feche por completo (⌘Q no macOS, fechar a janela não basta) e abra de novo. O Customermates aparece no painel de ferramentas com as ferramentas do CRM listadas.

Teste o seu primeiro prompt

O servidor fornece instruções de conexão que descrevem o conjunto de ferramentas, as regras de segurança e como buscar as páginas relevantes da Base de conhecimento. Cada cliente decide se repassa essas instruções ao agente. Se o seu não repassa, adicione a regra de busca da Base de conhecimento às instruções permanentes desse cliente. Nos clientes que aceitam prompts de MCP (como o Claude Code), você pode executar o prompt integrado get-started para um começo guiado: ele lê primeiro o seu espaço de trabalho e as páginas relevantes da Base de conhecimento e só então pergunta o que ainda falta.

• "Defina o campo Status do negócio da Acme como 'Ganho' e adicione uma nota dizendo que o contrato foi assinado hoje."
• "Mostre os últimos dez contatos que eu criei. Algum está sem endereço de e-mail?"
• "Crie um contato para Jane Doe na Initech, vincule-o à organização Initech e abra um negócio para 12 horas de consultoria."
• "Quais conversas com clientes estão esperando a minha resposta? Redija uma resposta para a mais antiga e salve como rascunho."

O prompt de resposta precisa de um canal conectado no Customermates Cloud a partir do Pro; o rascunho fica na conversa até você revisar e enviar.

Cada espaço de trabalho define os próprios tipos de registro, como contatos, negócios ou tarefas, e atributos como a etapa de um negócio ou a prioridade de uma tarefa também dependem da configuração do espaço de trabalho. Chame discover_record_types e depois get_record_model para obter os IDs de tipo relevantes antes de gravar.

Solução de problemas

Próximos passos

• Conector personalizado: o caminho OAuth para os apps do Claude e do ChatGPT.
• Catálogo de ferramentas MCP: todas as ferramentas que o agente pode chamar.
• Webhooks: inscreva outros sistemas nas mudanças do CRM.