ClickUpfy para Desenvolvimento
Usar o ClickUpfy da Promovaweb ou suas ferramentas MCP para consultar e
atualizar trabalho de engenharia. Manter as respostas compactas e preservar a
rastreabilidade das mudanças.
Documentação contínua
Quando o trabalho alterar o ClickUpfy, confira
,
,
docs/user/reading-order.txt
,
e os testes documentais. Cada comando
novo, flag, argumento, ferramenta MCP, formato de saída, limitação da API ou
mudança de comportamento precisa receber explicação, parâmetros, efeitos,
limites e cinco exemplos distintos de uso no capítulo de referência adequado.
Inclua também o comando ou a ferramenta no percurso indicado pelo caso de uso,
sem substituir a referência detalhada por um link. Atualize a versão do ebook,
regenere PDF e EPUB e execute a verificação do ebook quando a documentação
mudar. Não afirme que uma interface está documentada apenas porque aparece no
texto de ajuda ou em uma tabela de nomes.
Escolher a interface
- Usar ferramentas quando o servidor MCP estiver disponível.
- Usar pelo terminal quando as ferramentas MCP não estiverem
disponíveis.
- Executar primeiro para conhecer o destino fixado pelo
MCP do projeto.
- Usar quando o MCP não estiver disponível.
- Informar ou o argumento sem trocar o perfil
ativo apenas para uma consulta pontual.
Nunca ler, imprimir, comentar ou copiar o campo
de
. Não incluir credenciais em comandos,
logs, commits ou respostas.
Preservar o isolamento dos projetos
Tratar o
da pasta de trabalho como o destino do agente. Ele fixa o
perfil, workspace, Space, Folder e a List obrigatória nos argumentos de
, sem armazenar a API key. O Sprint Folder só aparece
quando o projeto usa Sprints.
Não executar
para alternar entre projetos paralelos. Cada projeto
deve manter seu próprio servidor. Conferir
antes da
primeira escrita e omitir IDs já fixados. O servidor rejeita perfil ou
hierarquia diferentes dos argumentos recebidos na inicialização.
O CLI não lê o
. Quando o MCP não estiver disponível, informar o
perfil e os IDs explicitamente:
bash
clickupfy --account <perfil> task list --list <list-id>
Navegar pelo trabalho
Quando houver um nome ou trecho da descrição, buscar no workspace:
bash
clickupfy task search --query "<texto>"
No MCP, usar
. Se a busca retornar mais de uma tarefa
plausível, mostrar as opções e pedir uma escolha antes de escrever no ClickUp.
Descobrir IDs pela hierarquia quando a busca não for suficiente:
bash
clickupfy workspace list
clickupfy space list
clickupfy folder list --space <space-id>
clickupfy list list --folder <folder-id>
clickupfy list get <list-id>
clickupfy task list --list <list-id>
Usar
em
quando a list não pertencer a um
folder. Acrescentar
quando os campos compactos não forem suficientes.
No MCP, seguir a mesma ordem com:
clickupfy_workspaces_list
;
- ;
- ;
- ;
- ;
- .
Não adivinhar IDs de workspace, space, folder, list, tarefa ou usuário.
Planejar com Sprints
Aplicar esta seção somente quando
informar um Sprint
Folder ou quando o usuário fornecer uma Sprint no escopo.
Localizar o Sprint Folder pela hierarquia e consultar a Sprint ativa antes de
alterar o planejamento:
bash
clickupfy sprint list --folder <sprint-folder-id>
clickupfy sprint current --folder <sprint-folder-id>
clickupfy sprint get <sprint-id>
clickupfy sprint tasks <sprint-id> --open-only
No MCP, usar
,
,
e
. Uma Sprint é uma List com
e
; não tratar uma List comum do Sprint Folder como
Sprint. O CLI não cria Sprints porque a API pública do ClickUp não oferece essa
operação.
Associar ou remover uma tarefa somente quando o usuário tiver incluído o
planejamento da Sprint no escopo:
bash
clickupfy sprint add-task <sprint-id> <task-id>
clickupfy sprint remove-task <sprint-id> <task-id>
clickupfy sprint set-points <task-id> <points>
No MCP, as operações equivalentes são
clickupfy_sprint_add_task
,
clickupfy_sprint_remove_task
e
clickupfy_sprint_set_points
. Reler a Sprint e a
tarefa depois de cada alteração.
Ler antes de alterar
- Obter a tarefa completa com
clickupfy task get <id> --json
ou
.
- Ler e percorrer na ordem retornada.
- Tratar cada pendente como uma unidade individual de trabalho,
preservando e .
- Ler os comentários com
clickupfy comment list --task <id> --json
ou
.
- Conferir status, descrição, responsáveis, datas, subtarefas e dependências
relevantes.
- Confirmar que a tarefa e o perfil pertencem ao escopo solicitado.
já reúne a tarefa principal, subtarefas aninhadas e itens
de checklist. Não reconstruir essa hierarquia por nome. Usar a chave
para tarefas e
checklist:<checklist-id>:<item-id>
para checklist
items.
Quando o agente precisar da tarefa inteira como um único contexto textual,
usar
clickupfy task get <id> --markdown
ou chamar
com
. Usar a resposta JSON sem essa opção quando a fila estruturada
for necessária para selecionar e atualizar itens.
Depois de concluir um checklist item, executar a ação
fornecida no
próprio item. Para marcar ou reabrir manualmente:
bash
clickupfy checklist set <task-id> <checklist-id> <item-id> --resolved
clickupfy checklist set <task-id> <checklist-id> <item-id> --open
No MCP, usar
clickupfy_checklist_item_set
. A ferramenta relê a tarefa depois
da escrita e só retorna o item quando
corresponde ao estado solicitado.
Para criar checklists e seus itens:
bash
clickupfy checklist create <task-id> --name "Testes"
clickupfy checklist item-create <checklist-id> --name "<teste>"
No MCP, usar
clickupfy_checklist_create
e
clickupfy_checklist_item_create
. Manter cada item aberto durante a criação.
Atualizar tarefas
Usar apenas os campos autorizados pelo pedido:
bash
clickupfy task create \
--list <list-id> \
--name "<nome>" \
--markdown-content "<markdown>" \
--parent "<task-id>" \
--start-date <AAAA-MM-DD> \
--due-date <AAAA-MM-DD>
clickupfy task update <task-id> --status "<status exato>"
clickupfy task update <task-id> --start-date <AAAA-MM-DD>
clickupfy task update <task-id> --priority 2
clickupfy task update <task-id> --points 5
clickupfy comment create --task <task-id> --text "<progresso>"
No MCP, usar
,
e
. Usar
,
,
e
para os campos equivalentes. Status são nomes configurados pela List;
ler
e usar a grafia real.
Antes de
ou
, obter autorização explícita e
confirmar o ID. A ferramenta MCP exige
; o CLI exige
.
Registrar tempo
Consultar primeiro se já existe um time entry:
bash
clickupfy time current
clickupfy time start --task <task-id> --description "<atividade>"
clickupfy time stop
Usar
,
e
no MCP.
Não iniciar outro time entry quando houver um em execução sem confirmar o que
deve acontecer com o registro atual. Essa conferência é obrigatória quando
processos paralelos usam o mesmo perfil e workspace.
Validar mudanças
Depois de cada escrita:
- Ler novamente a tarefa ou o recurso alterado.
- Comparar o valor persistido com o valor solicitado.
- Informar o ID, a mudança confirmada e qualquer pendência real.
- Nunca declarar sucesso usando apenas a ausência de erro do comando.