@marcelocorrea/mcp-clint
v1.0.0
Published
MCP server for Clint API integration
Maintainers
Readme
MCP Clint - Servidor de Protocolo de Contexto de Modelo
O MCP Clint é um servidor do Protocolo de Contexto de Modelo (MCP) que fornece integração com a plataforma Clint CRM. Ele atua como uma ponte entre modelos de IA e a API Clint, permitindo que assistentes de IA realizem operações em recursos Clint como contatos, negócios, organizações, tags, grupos, usuários, origens e itens de status perdidos.
Índice
- Visão Geral
- Recursos Disponíveis
- Configuração no Claude Code
- Instalação e Configuração
- Variáveis de Ambiente
- Exemplos de Uso
Visão Geral
O servidor foi desenvolvido em TypeScript e utiliza o SDK oficial do MCP para implementar um serviço que se comunica com a API Clint via requisições HTTP. Ele segue uma arquitetura baseada em ferramentas onde diferentes operações são expostas como ferramentas chamáveis que modelos de IA podem usar.
Recursos Disponíveis
O servidor expõe as seguintes ferramentas para que modelos de IA possam interagir:
1. Ferramenta de Contatos
- Operações: list, get, create, update, delete, add_tags, remove_tag
- Parâmetros: Suporta várias opções de filtro (limite, deslocamento, nome, e-mail, etc.) e detalhes de contato
2. Ferramenta de Negócios
- Operações: list, get, create, update, delete
- Parâmetros: Dados específicos de negócios e opções de filtragem
3. Ferramenta de Organizações
- Operações: get, update
- Parâmetros: ID da organização e campos de atualização
4. Ferramenta de Tags
- Operações: list, get, create, delete
- Parâmetros: Detalhes das tags e opções de filtragem
5. Ferramenta de Grupos
- Operações: list, get
- Parâmetros: Opções de filtragem de grupos
6. Ferramenta de Usuários
- Operações: list, get
- Parâmetros: Opções de filtragem de usuários
7. Ferramenta de Origens
- Operações: list, get
- Parâmetros: Opções de filtragem de origens
8. Ferramenta de Status Perdidos
- Operações: list, get
- Parâmetros: Opções de filtragem de status perdidos
9. Ferramenta de Conta
- Operações: list_fields
- Parâmetros: Opções de listagem de campos da conta
Configuração no Claude Code
O Claude Code suporta a integração com servidores MCP para estender as capacidades dos assistentes de IA. Para configurar o MCP Clint com o Claude, siga estes passos:
1. Instalação via NPM
Você pode instalar o pacote do MCP Clint globalmente:
npm install -g @marcelocorrea/mcp-clintDepois de instalado, você pode executar o servidor MCP:
CLINT_API_TOKEN=seu_token_aqui mcp-clint2. Execução Direta do Arquivo na Máquina
Se preferir executar o servidor a partir do código fonte:
- Clone o repositório:
git clone https://github.com/seu-usuario/mcp-clint.git
cd mcp-clint- Instale as dependências:
npm install- Execute o servidor em modo de desenvolvimento:
CLINT_API_TOKEN=seu_token_aqui npm run devPassos para Configuração no Claude:
Instale o Claude Code em seu ambiente de desenvolvimento (VS Code, JetBrains, etc.)
Configure o Servidor MCP:
- No Claude Code, vá até as configurações de MCP
- Adicione um novo servidor MCP
- Se você instalou via NPM, use o comando:
mcp-clint - Se estiver executando localmente, use o caminho para executar:
npm run devno diretório do projeto
Defina as variáveis de ambiente:
- Certifique-se de que a variável
CLINT_API_TOKENesteja definida com seu token de API Clint
- Certifique-se de que a variável
Teste a conexão:
- Após configurar, o Claude Code deve ser capaz de se comunicar com o servidor MCP Clint
- Você poderá usar os recursos Clint diretamente no assistente de IA
Instalação e Configuração
Pré-requisitos
- Node.js >= 18
- Um token de API Clint válido
Instalação
npm installCompilação
npm run buildIsso compila o código TypeScript para JavaScript no diretório dist.
Execução em Desenvolvimento
CLINT_API_TOKEN=seu_token_aqui npm run devExecução em Produção
npm startIsso executa o servidor JavaScript compilado.
Variáveis de Ambiente
CLINT_API_TOKEN: Obrigatório. Seu token de autenticação da API Clint.
Publicação e Distribuição
Este pacote está publicado no NPM como @marcelocorrea/mcp-clint. Para mais informações sobre publicação e desenvolvimento, consulte a documentação técnica no arquivo QWEN.md ou CLAUDE.md.
Instalação
# Instalação global
npm install -g @marcelocorrea/mcp-clint
# Instalação local em um projeto
npm install @marcelocorrea/mcp-clintLinks Úteis
Exemplos de Uso
Listar contatos
{
"name": "contacts",
"arguments": {
"operation": "list",
"limit": 10,
"offset": 0
}
}Criar um novo contato
{
"name": "contacts",
"arguments": {
"operation": "create",
"first_name": "João",
"last_name": "Silva",
"email": "[email protected]",
"phone": "+55 11 99999-9999"
}
}Obter detalhes de um negócio específico
{
"name": "deals",
"arguments": {
"operation": "get",
"id": "ID_DO_NEGÓCIO"
}
}Adicionar tags a um contato
{
"name": "contacts",
"arguments": {
"operation": "add_tags",
"id": "ID_DO_CONTATO",
"tag_ids": ["ID_DA_TAG1", "ID_DA_TAG2"]
}
}Para mais detalhes sobre os parâmetros e operações disponíveis, consulte a documentação completa no arquivo docs/clint-api-catalogo-v1.md.
