O ClickUpfy conecta o trabalho mantido no ClickUp ao terminal e aos agentes de código. Um único executável configura vários perfis, percorre a hierarquia do ClickUp, administra tarefas, checklists, Sprints, comentários e time tracking, instala skills no projeto e oferece as mesmas operações por MCP.
Este guia ensina essa jornada em sequência. Você começa instalando o CLI e associando uma API key a um workspace. Depois encontra os IDs do projeto, executa uma tarefa completa pelo terminal e prepara um MCP restrito para que o agente trabalhe somente na List autorizada.
Classificação
| Campo | Valor |
|---|---|
| Natureza | normativo |
| Escopo | percurso completo do usuário do ClickUpfy |
| Autoridade | interfaces públicas do CLI, servidor MCP e skills distribuídas |
Leia online ou como ebook
Estas páginas também formam o ClickUpfy — Guia completo do usuário. A pasta do ebook publica a versão vigente em PDF e EPUB e registra os hashes que comprovam a origem comum dos formatos.
O PDF favorece leitura, compartilhamento e impressão. O EPUB se adapta ao tamanho de fonte e ao leitor digital. Os dois são reconstruídos sempre que uma página desta documentação muda.
Percurso pedagógico
Siga esta ordem na primeira leitura:
- Entenda o ClickUpfy e os limites entre ClickUp, CLI, MCP e skills.
- Instale o CLI pelo npm ou por um executável standalone.
- Configure perfis e credenciais sem colocar a API key no repositório.
- Consulte a referência de perfis e hierarquia sempre que precisar de parâmetro, efeito persistente ou variação de comando.
- Prepare o primeiro projeto e confira o escopo antes de permitir escrita.
- Navegue pela hierarquia até encontrar Space, Folder, List e Sprint Folder.
- Trabalhe com tarefas e checklists, incluindo subtarefas, Markdown, datas e comentários.
- Consulte a referência de tarefas, checklists, comentários e tempo para parâmetros, formatos e confirmações de escrita.
- Planeje Sprints e acompanhe avanço por tarefas e Sprint Points.
- Consulte a referência de Sprints para os parâmetros de relatório, associação e Sprint Points.
- Registre tempo no item em execução.
- Instale e use as skills que acompanham criação, implementação e release.
- Conecte um agente por MCP com IDs fixos e opção read-only.
- Consulte a referência de Docs, skills e servidor MCP para os recursos de documentação dentro do ClickUp e a integração no projeto.
- Use a referência MCP de contexto e hierarquia para conhecer cada argumento aceito pelas ferramentas de navegação.
- Consulte a referência MCP de Docs e administração para o workspace, Docs, páginas e ferramentas condicionais do servidor.
- Consulte a referência MCP de trabalho para operações de tarefas, Sprints, checklists, comentários e tempo.
- Consulte a referência do CLI para comandos, argumentos e formatos de saída.
- Resolva falhas comuns de autenticação, escopo, status e integração.
O modelo mental em uma frase
O arquivo global guarda credenciais. Os arquivos do projeto guardam somente o
perfil e os IDs autorizados. O .mcp.json atende clientes que usam JSON, o
.codex/config.toml atende o Codex.
Essa divisão permite usar o mesmo ClickUpfy em vários projetos sem duplicar a API key. Um projeto pode apontar para a List de um produto, enquanto outro aponta para a List de um cliente. O MCP de cada raiz recusa IDs diferentes dos que foram fixados.
Comece por entender o papel de cada camada.