WHMCS MCP Tools

conjunto de ferramentas para gerenciamento do WHMCS

GitHub
24

Documentação

WHMCS MCP Server

CI Docker License: MIT TypeScript MCP Node.js

Um servidor Model Context Protocol (MCP) para gerenciar instalações WHMCS (Web Host Manager Complete Solution). Este servidor fornece ferramentas abrangentes para gerenciar clientes, produtos, cobrança, tickets de suporte, domínios e muito mais através da API WHMCS.

📚 Documentação

✨ Recursos

🤖 Prompts com IA

Modelos de prompt pré-construídos para fluxos de trabalho comuns do WHMCS:

  • Onboarding de Cliente - Configuração guiada de novo cliente
  • Resposta de Ticket - Gere respostas profissionais de suporte
  • Relatório de Receita - Análise financeira abrangente
  • Verificação de Saúde do Cliente - Avaliação do status da conta
  • Lembrete em Massa de Faturas - Acompanhamento automatizado de pagamentos
  • Auditoria de Expiração de Domínios - Gerenciamento proativo de domínios
  • Configuração de Novo Produto - Orientação de configuração de produtos
  • Investigação de Fraude - Fluxo de trabalho de análise de segurança

📊 Recursos em Tempo Real

Endpoints de dados em tempo real para acesso instantâneo:

  • Estatísticas do sistema (whmcs://stats)
  • Catálogo de produtos (whmcs://products)
  • Departamentos de suporte (whmcs://support/departments)
  • Métodos de pagamento (whmcs://payment-methods)
  • Moedas (whmcs://currencies)
  • Servidores (whmcs://servers)
  • Preços de TLD (whmcs://tld-pricing)
  • Promoções (whmcs://promotions)
  • Status de tickets (whmcs://support/statuses)
  • Itens de tarefas do administrador (whmcs://admin/todo)

Gerenciamento de Clientes

  • Listar, pesquisar e filtrar clientes
  • Obter informações detalhadas do cliente
  • Criar, atualizar e excluir clientes
  • Visualizar produtos e serviços do cliente
  • Visualizar domínios do cliente

Gerenciamento de Produtos

  • Listar produtos disponíveis
  • Obter grupos de produtos
  • Visualizar preços de produtos

Cobrança e Faturas

  • Listar e filtrar faturas
  • Criar e atualizar faturas
  • Adicionar pagamentos a faturas
  • Aplicar créditos
  • Visualizar transações

Tickets de Suporte

  • Listar e filtrar tickets
  • Visualizar detalhes e respostas de tickets
  • Criar novos tickets
  • Responder a tickets
  • Atualizar status do ticket
  • Obter departamentos e status de suporte

Gerenciamento de Domínios

  • Registrar, transferir e renovar domínios
  • Gerenciar nameservers
  • Bloquear/desbloquear domínios
  • Obter preços de TLD
  • Visualizar informações WHOIS

Gerenciamento de Pedidos

  • Listar e filtrar pedidos
  • Aceitar, cancelar ou excluir pedidos
  • Marcar pedidos como fraudulentos
  • Definir pedidos como pendentes

Gerenciamento de Servidores e Módulos

  • Listar servidores configurados
  • Criar/provisionar serviços
  • Suspender/reativar serviços
  • Encerrar serviços
  • Alterar senhas de serviços

Ferramentas do Sistema

  • Obter estatísticas do sistema
  • Visualizar usuários administradores
  • Obter métodos de pagamento e moedas
  • Registro de atividades
  • Modelos de e-mail
  • Itens de tarefas

Recursos Adicionais

  • Gerenciamento de afiliados
  • Gerenciamento de promoções/cupons
  • Gerenciamento de cotações

🔧 Instalação

Opção 1: Docker (Recomendado)

docker run -it --rm \
  -e WHMCS_API_URL="https://billing.example.com/" \
  -e WHMCS_API_IDENTIFIER="your-identifier" \
  -e WHMCS_API_SECRET="your-secret" \
  ghcr.io/scarecr0w12/whmcs-mcp-tool:latest

Consulte o Guia Docker para instruções detalhadas de implantação Docker.

Opção 2: A partir do código-fonte

  1. Clone este repositório:

    git clone https://github.com/scarecr0w12/whmcs-mcp-tool.git
cd whmcs-mcp-tool

  2. Instale as dependências:

    npm install

  3. Compile o projeto:

    npm run build

  4. Configure suas credenciais WHMCS:

    cp .env.example .env
# Edit .env with your WHMCS API credentials

⚙️ Configuração

Para instruções detalhadas de configuração, consulte o Guia de Configuração.

Início Rápido

  1. Crie credenciais de API no WHMCS: Setup → Staff Management → API Credentials
  2. Copie o modelo de ambiente: cp .env.example .env
  3. Edite .env com suas credenciais WHMCS

Variáveis de Ambiente

Defina as seguintes variáveis de ambiente:

VariávelObrigatóriaDescrição
WHMCS_API_URLSimURL da sua instalação WHMCS (ex.: https://billing.example.com/)
WHMCS_API_IDENTIFIERSimIdentificador da credencial de API
WHMCS_API_SECRETSimSegredo da credencial de API
WHMCS_ACCESS_KEYNãoChave de acesso de API opcional para segurança adicional

Chave de Acesso à API (Opcional)

Para segurança adicional, você pode configurar uma Chave de Acesso à API:

  1. No administrador do WHMCS, vá para Setup > General Settings > Security
  2. Defina o campo API Access Key
  3. Adicione esta chave à sua variável de ambiente WHMCS_ACCESS_KEY

🚀 Uso

Com VS Code

O servidor pode ser usado diretamente com o suporte MCP do VS Code. A configuração já está definida em .vscode/mcp.json.

  1. Defina suas variáveis de ambiente
  2. Compile o projeto: npm run build
  3. O servidor MCP estará disponível no VS Code

Execução Manual

# Development mode with auto-reload
npm run dev

# Production mode
npm run build
npm start

🛠️ Ferramentas Disponíveis

Para documentação completa de parâmetros, consulte a Referência da API.

Ferramentas de Cliente

  • whmcs_get_clients - Obter lista de clientes
  • whmcs_get_client_details - Obter informações detalhadas do cliente
  • whmcs_add_client - Criar um novo cliente
  • whmcs_update_client - Atualizar um cliente existente
  • whmcs_delete_client - Excluir um cliente
  • whmcs_get_client_products - Obter produtos/serviços do cliente
  • whmcs_get_client_domains - Obter domínios do cliente

Ferramentas de Produto

  • whmcs_get_products - Obter produtos disponíveis
  • whmcs_get_product_groups - Obter grupos de produtos

Ferramentas de Fatura

  • whmcs_get_invoices - Obter faturas
  • whmcs_get_invoice - Obter detalhes da fatura
  • whmcs_create_invoice - Criar uma fatura
  • whmcs_update_invoice - Atualizar uma fatura
  • whmcs_add_payment - Adicionar pagamento à fatura
  • whmcs_apply_credit - Aplicar crédito à fatura
  • whmcs_get_transactions - Obter transações

Ferramentas de Ticket

  • whmcs_get_tickets - Obter tickets de suporte
  • whmcs_get_ticket - Obter detalhes do ticket
  • whmcs_open_ticket - Criar um novo ticket
  • whmcs_add_ticket_reply - Responder a um ticket
  • whmcs_update_ticket - Atualizar propriedades do ticket
  • whmcs_delete_ticket - Excluir um ticket
  • whmcs_get_support_departments - Obter departamentos de suporte
  • whmcs_get_support_statuses - Obter status de tickets

Ferramentas de Domínio

  • whmcs_register_domain - Registrar um domínio
  • whmcs_transfer_domain - Transferir um domínio
  • whmcs_renew_domain - Renovar um domínio
  • whmcs_get_domain_whois - Obter informações WHOIS
  • whmcs_get_domain_nameservers - Obter nameservers
  • whmcs_update_domain_nameservers - Atualizar nameservers
  • whmcs_get_domain_lock_status - Obter status de bloqueio
  • whmcs_update_domain_lock_status - Atualizar status de bloqueio
  • whmcs_get_tld_pricing - Obter preços de TLD

Ferramentas de Pedido

  • whmcs_get_orders - Obter pedidos
  • whmcs_accept_order - Aceitar um pedido
  • whmcs_cancel_order - Cancelar um pedido
  • whmcs_delete_order - Excluir um pedido
  • whmcs_fraud_order - Marcar como fraudulento
  • whmcs_pending_order - Definir como pendente

Ferramentas de Servidor e Módulo

  • whmcs_get_servers - Obter servidores configurados
  • whmcs_module_create - Criar/provisionar serviço
  • whmcs_module_suspend - Suspender serviço
  • whmcs_module_unsuspend - Reativar serviço
  • whmcs_module_terminate - Encerrar serviço
  • whmcs_module_change_password - Alterar senha do serviço

Ferramentas do Sistema

  • whmcs_get_stats - Obter estatísticas do sistema
  • whmcs_get_admin_users - Obter usuários administradores
  • whmcs_get_payment_methods - Obter métodos de pagamento
  • whmcs_get_currencies - Obter moedas
  • whmcs_get_activity_log - Obter registro de atividades
  • whmcs_log_activity - Registrar uma atividade
  • whmcs_get_email_templates - Obter modelos de e-mail
  • whmcs_send_email - Enviar um e-mail
  • whmcs_get_todo_items - Obter itens de tarefas

Ferramentas de Afiliado

  • whmcs_get_affiliates - Obter afiliados
  • whmcs_activate_affiliate - Ativar um afiliado

Ferramentas de Promoção

  • whmcs_get_promotions - Obter promoções/cupons

Ferramentas de Cotação

  • whmcs_get_quotes - Obter cotações
  • whmcs_create_quote - Criar uma cotação
  • whmcs_accept_quote - Aceitar uma cotação
  • whmcs_delete_quote - Excluir uma cotação

🔒 Considerações de Segurança

  1. Nunca envie seu arquivo .env para o repositório - Ele contém credenciais de API sensíveis
  2. Use Chaves de Acesso à API - Para uma camada adicional de segurança
  3. Restrições de IP - Configure restrições de IP no WHMCS para acesso à API
  4. Permissões Mínimas - Ative apenas as funções de API que você precisa
  5. Somente HTTPS - Sempre use HTTPS para sua instalação WHMCS

🧪 Testes

Execute o script de teste para verificar sua conexão WHMCS:

npx tsx src/test.ts

💻 Desenvolvimento

Consulte CONTRIBUTING.md para diretrizes de desenvolvimento.

# Install dependencies
npm install

# Run in development mode
npm run dev

# Build for production
npm run build

# Watch mode for development
npm run watch

📄 Licença

Este projeto é licenciado sob a Licença MIT - consulte o arquivo LICENSE para obter detalhes.

🔗 Links