GitScrum / Docs

NoteVault

Gerenciamento do NoteVault pelo MCP. Crie, organize e compartilhe notas pessoais e de equipe com organização por pastas e rastreamento de revisõ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.

NoteVault é seu workspace pessoal e de equipe para notas — resumos de reuniões, retrospectivas de sprint, logs de pesquisa, rascunhos de arquitetura e qualquer coisa que ainda não pertença à documentação no nível de projeto. Duas ferramentas trabalham juntas para gerenciar o NoteVault: a ferramenta note para criar e compartilhar notas, e a ferramenta note_folder para organizar notas em pastas.

Diferente das páginas Wiki, que são documentação com escopo de projeto, notas do NoteVault pertencem a você. Elas vivem no seu workspace, podem ser organizadas em pastas pessoais e compartilhadas com membros específicos da equipe quando prontas. O rastreamento de revisões permite revisar versões anteriores de qualquer nota.


Ferramenta Note — Visão Geral das Ações

A ferramenta note fornece 6 ações para o ciclo de vida completo das notas:

AçãoPropósitoParâmetros Obrigatórios
listListar todas as suas notascompany_slug
getObter conteúdo completo de uma nota específicauuid, company_slug
createCriar uma nova notacompany_slug, title, content
updateModificar uma nota existenteuuid, company_slug
shareCompartilhar uma nota com membros da equipeuuid, company_slug
revisionsVer histórico de revisões de uma notauuid, company_slug

Ferramenta Note Folder — Visão Geral das Ações

A ferramenta note_folder fornece 4 ações para gerenciamento de pastas:

AçãoPropósitoParâmetros Obrigatórios
listListar todas as pastas de notascompany_slug
createCriar uma nova pastacompany_slug, name
updateRenomear uma pastauuid, company_slug, name
moveMover uma nota para dentro ou fora de uma pastanoteuuid, companyslug

Listando Notas

A ação list retorna todas as notas no seu workspace. Cada nota na resposta inclui seu uuid, título, atribuição de pasta, data de criação e status de compartilhamento.

Parâmetros Obrigatórios

ParameterTypeDescription
company_slugstringIdentificador do workspace (da ferramenta workspace)
You:  "Mostre todas as minhas notas"
AI:   Chama note action=list → retorna seu inventário completo de notas

You:  "Liste minhas notas no workspace Acme"
AI:   Chama note action=list com company_slug → retorna notas do workspace

You:  "Que notas eu tenho?"
AI:   Chama note action=list → resume suas notas por pasta e data

Criando Notas

A ação create constrói uma nova nota com título e conteúdo em Markdown. Notas são criadas no seu workspace pessoal — são privadas até serem explicitamente compartilhadas.

Parâmetros Obrigatórios

ParameterTypeDescription
company_slugstringIdentificador do workspace
titlestringTítulo da nota
contentstringCorpo da nota em formato Markdown

Exemplos de Prompts

You:  "Crie uma nota 'Retrospectiva Sprint 14' com anotações da reunião de hoje"
AI:   Chama note action=create com título e conteúdo em Markdown

You:  "Crie uma nota sobre a pesquisa de migração de banco de dados que venho fazendo"
AI:   Chama note action=create com notas de pesquisa formatadas em Markdown

You:  "Anote: 'Reunião com Cliente — acordamos o roadmap do Q2,
       prioridade é lançamento do app mobile até março'"
AI:   Chama note action=create com notas da reunião

You:  "Crie uma nota resumindo as opções de arquitetura que discutimos"
AI:   Chama note action=create com comparação estruturada em Markdown

Atualizando Notas

A ação update modifica o título ou conteúdo de uma nota. Apenas os campos que você especificar são alterados.

Parâmetros Obrigatórios

ParameterTypeDescription
uuidstringUUID da nota (da resposta list ou get)
company_slugstringIdentificador do workspace

Parâmetros Opcionais

ParameterTypeDescription
titlestringTítulo atualizado da nota
contentstringCorpo atualizado da nota em formato Markdown
You:  "Atualize minha nota de retrospectiva com os itens de ação que acordamos"
AI:   Encontra a nota → chama note action=update com conteúdo revisado

You:  "Adicione uma seção de follow-up às minhas notas da reunião com o cliente"
AI:   Obtém conteúdo atual → adiciona follow-up → chama note action=update

You:  "Renomeie minha nota de pesquisa para 'Migração de Banco de Dados — Recomendação Final'"
AI:   Chama note action=update com title

Compartilhando Notas

A ação share torna uma nota visível para membros específicos da equipe por nome de usuário. Notas compartilhadas aparecem na lista de notas do destinatário, permitindo revisão colaborativa.

Parâmetros Obrigatórios

ParameterTypeDescription
uuidstringUUID da nota
company_slugstringIdentificador do workspace

Parâmetros

ParameterTypeDescription
usernamesarray of stringsNomes de usuário dos membros da equipe para compartilhar a nota
You:  "Compartilhe minha nota de retrospectiva com @sarah e @john"
AI:   Chama note action=share com usernames=["sarah", "john"]

You:  "Compartilhe a nota de pesquisa de arquitetura com a equipe de backend"
AI:   Resolve membros da equipe → chama note action=share com seus nomes de usuário

You:  "Compartilhe minhas notas de reunião com o gerente de projetos"
AI:   Identifica o PM → chama note action=share com seu nome de usuário

Histórico de Revisões

A ação revisions retorna o histórico de versões de uma nota — cada vez que o conteúdo foi atualizado, uma revisão é registrada. Isso permite rastrear como uma nota evoluiu ao longo do tempo e referenciar versões anteriores.

Parâmetros Obrigatórios

ParameterTypeDescription
uuidstringUUID da nota
company_slugstringIdentificador do workspace
You:  "Mostre o histórico de revisões da minha nota de arquitetura"
AI:   Chama note action=revisions → retorna lista de revisões com timestamps

You:  "Quantas vezes a nota de onboarding foi atualizada?"
AI:   Chama note action=revisions → conta as revisões

You:  "Como estavam as notas da reunião antes da última edição?"
AI:   Chama note action=revisions → retorna conteúdo da versão anterior

Gerenciando Pastas

Pastas de notas organizam suas notas em grupos lógicos. A ferramenta note_folder lida com criação, renomeação e movimentação de notas entre pastas.

Listando Pastas

Retorna todas as pastas no seu workspace, cada uma com seu uuid e name.

ParameterTypeDescription
company_slugstringIdentificador do workspace (obrigatório)
You:  "Mostre minhas pastas de notas"
AI:   Chama note_folder action=list → retorna lista de pastas com UUIDs

You:  "Como minhas notas estão organizadas?"
AI:   Chama note_folder action=list + note action=list → mostra estrutura de pastas

Criando Pastas

Cria uma nova pasta para organizar notas.

ParameterTypeDescription
company_slugstringIdentificador do workspace (obrigatório)
namestringNome da pasta (obrigatório)
You:  "Crie uma pasta chamada 'Notas de Reunião'"
AI:   Chama note_folder action=create com name="Notas de Reunião"

You:  "Crie pastas para 'Retros de Sprint', 'Pesquisa' e 'Reuniões com Clientes'"
AI:   Chama note_folder action=create três vezes com cada nome

Renomeando Pastas

Atualiza o nome de uma pasta existente.

ParameterTypeDescription
uuidstringUUID da pasta (obrigatório)
company_slugstringIdentificador do workspace (obrigatório)
namestringNovo nome da pasta (obrigatório)
You:  "Renomeie a pasta 'Notas de Reunião' para 'Reuniões de Equipe'"
AI:   Encontra a pasta → chama note_folder action=update com name="Reuniões de Equipe"

Movendo Notas

Move uma nota para dentro de uma pasta, ou remove de uma pasta (desarquivando). Omita folder_uuid para remover uma nota da sua pasta atual.

ParameterTypeDescription
note_uuidstringUUID da nota (obrigatório)
company_slugstringIdentificador do workspace (obrigatório)
folder_uuidstringUUID da pasta de destino. Omita para remover a nota da pasta.
You:  "Mova minha nota de retrospectiva para a pasta Retros de Sprint"
AI:   Encontra nota + pasta → chama note_folder action=move com ambos os UUIDs

You:  "Remova a nota de arquitetura da sua pasta"
AI:   Chama note_folder action=move com note_uuid apenas (sem folder_uuid)

You:  "Mova todas as notas de reunião para a pasta Reuniões de Equipe"
AI:   Lista notas → identifica notas de reunião → chama move para cada uma

Fluxo de Organização por Pastas

Construa um workspace pessoal estruturado para gerenciamento eficiente de notas:

1. Configure a estrutura de pastas

Crie pastas que correspondam aos seus padrões de trabalho.

You:  "Crie pastas de notas: 'Retros de Sprint', 'Reuniões com Clientes',
       'Pesquisa', 'Decisões de Arquitetura'"
AI:   Cria quatro pastas em sequência

2. Crie e organize notas

Crie notas e arquive-as imediatamente, ou organize notas existentes.

You:  "Crie uma nota 'Retro Sprint 14' com o feedback da retrospectiva de hoje
       e coloque na pasta Retros de Sprint"
AI:   Cria nota → move para a pasta Retros de Sprint

You:  "Mova todas as minhas notas não organizadas desta semana para as pastas apropriadas"
AI:   Lista notas → categoriza por conteúdo → move cada uma para a pasta correspondente

3. Compartilhe quando pronto

Compartilhe notas polidas com membros da equipe para revisão ou referência.

You:  "Compartilhe a nota Retro Sprint 14 com toda a equipe de backend"
AI:   Resolve membros da equipe → compartilha a nota com todos os nomes de usuário

4. Acompanhe a evolução

Use o histórico de revisões para ver como as notas evoluíram ao longo das iterações.

You:  "Mostre como minha nota de decisão de arquitetura mudou ao longo do tempo"
AI:   Chama note action=revisions → exibe a linha do tempo de revisões

NoteVault vs Wiki vs Discussões

Escolha a ferramenta de colaboração certa:

AspectoNoteVault (esta ferramenta)WikiDiscussões
PropriedadePessoal, opcionalmente compartilhadaDo projetoDo projeto
OrganizaçãoBaseada em pastasPáginas hierárquicasComentários em threads
VisibilidadePrivada até ser compartilhadaTodos os membros do projetoTodos os membros do projeto
VersionamentoHistórico de revisõesAtualizações de páginaThread de comentários
Melhor paraNotas de reunião, pesquisa, rascunhosRunbooks, guias, referênciasDecisões, propostas, debates

Fluxo típico: Comece com uma nota no NoteVault para rascunhos e anotações de reuniões. Quando o conteúdo amadurecer, mova para uma página Wiki para a equipe. Se um tópico precisar de discussão, crie uma thread de Discussão.


Resolução Automática de Contexto

As ferramentas note e note_folder suportam resolução automática de contexto. Se seu assistente de IA conhece o workspace de uma chamada anterior, você pode dizer "crie uma nota" sem especificar o workspace toda vez.


Próximos Passos

  • Wiki: Crie documentação no nível de projeto a partir das suas notas polidas.
  • Discussões: Inicie threads de discussão no nível de projeto.
  • Pesquisa: Encontre conteúdo em todas as entidades do GitScrum.
  • Início Rápido: Configure o MCP server se ainda não o fez.