Imported from RLuf/fzwhmcs-mcp-ai (
AGENTS.md). Install upstream withnpx skills add RLuf/fzwhmcs-mcp-ai. Copyright stays with the author.
AGENTS.md — fzWHMCS MCP AI
Instruções para manter o addon MCP atualmente instalado no WHMCS.
1. Escopo
- Código ativo:
fzmcp/. - Código histórico:
imovelsite/; não implantar no provisionamento atual. - Produção do ImovelSite:
RLuf/imovelsite-whmcs-module. - Produto comercial mais amplo:
RLuf/fzwhmcs-ai; não copiar seus arquivos para produção sem comparar versões, schemas e migrações.
2. Regras invioláveis
- Ferramentas de escrita ficam bloqueadas por padrão.
- Nunca habilitar
actem massa ou por conveniência de teste. - Bearer bruto aparece uma única vez e nunca entra no Git/log.
- O banco guarda somente hash do token.
- O addon usa
localAPI(); não criar campo de senha administrativa. - Endpoint HTTP exige HTTPS, token válido e origem controlada.
- Respostas e logs não podem expor senha, token, chave, hash ou payload sensível do WHMCS.
hooks.phpé carregado globalmente: manter mínimo e sem consulta pesada.- Não modificar produto 89, Iugu, Nota Fácil/Edvan ou provisionamento durante trabalho exclusivo do MCP.
- Atualização do WHMCS segue
docs/WHMCS-UPGRADE.md.
3. Versão e release
A versão precisa coincidir em:
fzmcp/fzmcp.php(fzmcp_config);fzmcp/whmcs.json, enquanto o manifesto mantiver o campo;- documentação e artefato publicado;
- registro
tbladdonmodulesapós a atualização.
Mudança de schema ou configuração exige lógica idempotente em
fzmcp_upgrade($vars). Upgrade nunca pode regenerar token, redefinir permissões
ou apagar escolhas do operador.
4. Fluxo obrigatório
- Ler este arquivo,
README.mde o documento relacionado. - Preservar mudanças existentes (
git status --short). - Comparar fonte, instalação e versão registrada.
- Fazer backup de banco/arquivos do WHMCS antes de escrita.
- Alterar a fonte, testes e documentação juntos.
- Rodar lint e
bin/selftest.php. - Instalar em cópia isolada ou janela autorizada.
- Executar upgrade do addon e confirmar token/permissões preservados.
- Testar endpoint anônimo (
401) e autenticado (initialize,tools/list, leitura segura). - Confirmar que escrita continua bloqueada.
- Commitar e enviar após o gate.
5. Testes
find fzmcp -name '*.php' -print0 | xargs -0 -n1 php -l
php fzmcp/bin/selftest.php
git diff --check
No Bells, use a CLI PHP compatível com WHMCS/ionCube, não necessariamente o
php padrão.
6. Documentação obrigatória
Toda tool nova ou alterada deve documentar:
- ação WHMCS real;
- categoria, leitura/escrita e nível padrão;
- schema e parâmetros obrigatórios;
- retorno e erros;
- permissão necessária;
- teste com mock e, para leitura segura, teste live;
- impacto de upgrade e rollback.
Atualize contagens de ferramentas somente a partir de ToolRegistry, nunca por
memória. Não documente uma ação como funcional se ela não existe na versão alvo
do WHMCS.