GitScrum / Docs

Comentários

Gerenciamento de comentários em tarefas pelo MCP. Adicione, liste e atualize comentários em tarefas para facilitar a colaboração e rastrear decisões.

Código Aberto — O GitScrum MCP Server é código aberto sob a licença MIT. Disponível no npm e no GitHub. Servidor Model Context Protocol para GitScrum — Claude, GitHub Copilot, Cursor e qualquer cliente compatível com MCP têm acesso operacional completo à sua stack de gerenciamento de projetos.

A ferramenta comment fornece 3 ações para gerenciar comentários no nível de tarefas — o canal principal de comunicação para colaboração específica de tarefas. Cada nota de code review, atualização de status, pergunta de implementação e decisão técnica que pertence a uma tarefa flui através desta ferramenta. Comentários suportam Markdown completo, permitindo conteúdo rico com blocos de código, formatação inline, listas e links.

Comentários de tarefas diferem das Discussões em escopo. Discussões são threads no nível de projeto para tópicos amplos e decisões. Comentários são no nível de tarefa — focados especificamente em um item de trabalho, formando a narrativa de implementação que membros da equipe consultam durante code reviews, standups e retrospectivas.


Visão Geral das Ações

AçãoPropósitoParâmetros Obrigatórios
listListar todos os comentários de uma tarefataskuuid, companyslug, project_slug
createAdicionar um novo comentário a uma tarefataskuuid, companyslug, project_slug, comment
updateEditar um comentário existenteuuid, taskuuid, companyslug, project_slug, comment

Listando Comentários

A ação list retorna todos os comentários de uma tarefa em ordem cronológica. Cada comentário inclui seu uuid, autor, timestamp de criação e conteúdo em Markdown. Isso fornece o histórico completo da conversa para qualquer tarefa.

Parâmetros Obrigatórios

ParameterTypeDescription
task_uuidstringUUID da tarefa (de qualquer listagem de tarefas, resposta get ou by_code)
company_slugstringIdentificador do workspace (da ferramenta workspace)
project_slugstringIdentificador do projeto (da ferramenta project)

Exemplos de Prompts

You:  "Mostre todos os comentários da tarefa PROJ-42"
AI:   Resolve a tarefa pelo código → chama comment action=list → retorna thread de comentários

You:  "O que foi discutido na tarefa de correção do login?"
AI:   Encontra a tarefa → chama comment action=list → resume a conversa

You:  "Liste os comentários da tarefa de migração da API"
AI:   Chama comment action=list → retorna histórico cronológico de comentários

Criando Comentários

A ação create adiciona um novo comentário a uma tarefa. Comentários suportam formatação Markdown completa — use blocos de código para trechos de código, listas para itens de ação e cabeçalhos para atualizações estruturadas.

Parâmetros Obrigatórios

ParameterTypeDescription
task_uuidstringUUID da tarefa para comentar
company_slugstringIdentificador do workspace
project_slugstringIdentificador do projeto
commentstringCorpo do comentário em formato Markdown

Exemplos de Prompts

You:  "Adicione um comentário na PROJ-42: 'Corrigi a exceção de null pointer
       no middleware de auth. Veja o commit abc123.'"
AI:   Resolve a tarefa → chama comment action=create com comentário em Markdown

You:  "Comente na tarefa de login com uma nota de code review sobre
       o regex de validação de senha"
AI:   Encontra a tarefa → chama comment action=create com detalhe técnico

You:  "Poste uma atualização de status na tarefa de deploy: testes de staging passaram,
       pronto para produção"
AI:   Chama comment action=create com atualização de status formatada em Markdown

You:  "Adicione um comentário listando o trabalho restante:
       - Atualizar docs da API
       - Adicionar testes de integração
       - Atualizar changelog"
AI:   Chama comment action=create com checklist em Markdown

Suporte a Markdown

Comentários aceitam Markdown completo. Padrões comuns para comentários de tarefas:

## Atualização de Status
Testes de staging passaram. Todas as 247 assertivas verdes.

## Trabalho Restante
- Atualizar documentação da API
- Adicionar testes de integração para edge cases
- Atualizar CHANGELOG.md

## Referência de Código
A correção está em `auth/middleware.ts`:

if (!token) { throw new UnauthorizedError('Token required'); }


Atualizando Comentários

A ação update substitui o conteúdo de um comentário existente. Isso requer o uuid do comentário (de uma resposta list) mais o contexto da tarefa. O corpo inteiro do comentário é substituído pelo novo conteúdo.

Parâmetros Obrigatórios

ParameterTypeDescription
uuidstringUUID do comentário (da resposta list)
task_uuidstringUUID da tarefa à qual o comentário pertence
company_slugstringIdentificador do workspace
project_slugstringIdentificador do projeto
commentstringNovo corpo do comentário em formato Markdown (substitui o conteúdo existente)

Exemplos de Prompts

You:  "Atualize meu último comentário na PROJ-42 para incluir os resultados de benchmark"
AI:   Lista comentários → identifica o mais recente → chama comment action=update
      com o conteúdo revisado em Markdown

You:  "Corrija o erro de digitação no meu comentário sobre o endpoint da API"
AI:   Lista comentários → encontra o comentário → chama comment action=update

You:  "Substitua minha atualização de status por: 'Todos os testes passando. Deploy em staging.
       Deploy em produção agendado para segunda.'"
AI:   Encontra o comentário → chama comment action=update com novo conteúdo

Fluxo de Colaboração em Tarefas

Comentários são a narrativa em tempo real da execução de tarefas. Combinados com outras ferramentas MCP, formam um fluxo de trabalho completo de colaboração:

1. Pegue a tarefa

Verifique os detalhes da tarefa e comentários existentes antes de começar o trabalho.

You:  "Mostre a tarefa PROJ-42 e seus comentários"
AI:   Chama task action=by_code → depois comment action=list
      → retorna detalhes da tarefa com histórico completo de comentários

2. Poste notas de implementação

Deixe comentários conforme trabalha na tarefa — decisões tomadas, bloqueios encontrados, abordagens testadas.

You:  "Comente na PROJ-42: 'Investiguei o problema de timeout.
       Causa raiz é o limite de connection pool ausente.
       Implementando correção com máximo de 20 conexões.'"
AI:   Chama comment action=create com a nota de implementação

3. Solicite feedback

Poste trechos de código ou perguntas técnicas para revisão da equipe.

You:  "Adicione um comentário perguntando à equipe sobre a abordagem de tratamento de erros:
       devemos fazer retry no 503 ou falhar imediatamente?"
AI:   Cria um comentário com a pergunta para contribuições da equipe

4. Atualize com progresso

Mantenha a thread de comentários atualizada conforme a tarefa avança.

You:  "Atualize meu último comentário — a correção do connection pool foi deployada em staging"
AI:   Encontra seu último comentário → chama comment action=update

5. Documente a resolução

Deixe um comentário final resumindo o que foi feito antes de fechar a tarefa.

You:  "Adicione um comentário de conclusão na PROJ-42: 'Corrigido adicionando limite
       de connection pool de 20. Deploy em produção. Monitoramento mostra 0 timeouts
       desde o deploy.' Depois complete a tarefa."
AI:   Cria o comentário → chama task action=complete

Comentários vs Discussões

Escolha a ferramenta certa para a conversa:

AspectoComentários (esta ferramenta)Discussões
EscopoAnexados a uma tarefa específicaThread no nível de projeto
PropósitoNotas de implementação, code review, atualizações de statusDecisões de arquitetura, propostas, planejamento
Ciclo de vidaVive com a tarefa — move com ela, arquiva com elaIndependente de tarefas individuais
Melhor para"Como está o progresso desta tarefa?""Qual abordagem devemos usar?"

Quando uma thread de comentários em uma tarefa se transforma em uma decisão mais ampla, considere criar uma Discussão para dar ao tópico seu próprio espaço. Referencie a discussão em um comentário da tarefa para que a conexão fique clara.


Resolução Automática de Contexto

A ferramenta de comentários suporta resolução automática de contexto. Se o assistente de IA já conhece o workspace, projeto e tarefa de uma chamada anterior na conversa, ele carrega esse contexto adiante. Você pode dizer "adicione um comentário" sem re-especificar a tarefa, desde que o contexto da tarefa tenha sido estabelecido anteriormente.

Quando um comentário é criado ou listado, o MCP server retorna metadados de contexto (companyslug, projectslug, task_uuid) que o assistente de IA usa para operações subsequentes.


Próximos Passos

  • Discussões: Crie threads de discussão no nível de projeto para tópicos mais amplos.
  • Tarefas: Gerencie as tarefas às quais os comentários estão anexados.
  • Wiki: Documente decisões e processos em páginas wiki do projeto.
  • Início Rápido: Configure o MCP server se ainda não o fez.