Wiki

Gerenciamento de wiki pelo MCP. Crie, organize e pesquise páginas wiki de projetos para documentação da equipe e bases de conhecimento.

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 wiki fornece 5 ações para criar, organizar e pesquisar páginas wiki de projetos. Wikis são a documentação viva da sua equipe — guias de onboarding, decisões de arquitetura, referências de API, runbooks e documentação de processos que permanece dentro do contexto do projeto e evolui com a base de código.

Páginas wiki suportam conteúdo Markdown completo e organização hierárquica através de relações pai-filho. Seu assistente de IA pode criar estruturas inteiras de documentação, atualizar páginas existentes e pesquisar em todo o conteúdo da wiki — tudo através de conversa em linguagem natural.

Visão Geral das Ações

Ação	Propósito	Parâmetros Obrigatórios
`list`	Listar todas as páginas wiki de um projeto	`companyslug`, `project``slug`
`get`	Obter conteúdo completo de uma página wiki específica	`uuid`, `companyslug`, `project``slug`
`create`	Criar uma nova página wiki	`companyslug`, `project``slug`, `title`, `content`
`update`	Modificar título ou conteúdo de uma página wiki existente	`uuid`, `companyslug`, `project``slug`
`search`	Pesquisar conteúdo da wiki por palavra-chave	`companyslug`, `project``slug`, `q`

Listando Páginas Wiki

A ação list retorna todas as páginas wiki dentro de um projeto. Cada página na resposta inclui seu uuid, título, autor, data de criação e referência à página pai — fornecendo a estrutura completa da árvore de páginas.

Parâmetros Obrigatórios

Parameter	Type	Description
`company_slug`	string	Identificador do workspace (da ferramenta `workspace`)
`project_slug`	string	Identificador do projeto (da ferramenta `project`)

You:  "Liste todas as páginas wiki do projeto Backend"
AI:   Chama wiki action=list → retorna árvore de páginas com títulos e hierarquia

You:  "Mostre a estrutura de documentação do projeto Mobile App"
AI:   Chama wiki action=list → exibe páginas organizadas por relações pai-filho

You:  "Que documentação existe neste projeto?"
AI:   Chama wiki action=list → resume as páginas wiki disponíveis

Obtendo Conteúdo da Página Wiki

A ação get retorna a página wiki completa — título, conteúdo em Markdown, autor, timestamps e referência à página pai. É assim que você lê uma página de documentação específica.

Parâmetros Obrigatórios

Parameter	Type	Description
`uuid`	string	UUID da página wiki (da resposta `list` ou `search`)
`company_slug`	string	Identificador do workspace
`project_slug`	string	Identificador do projeto

You:  "Mostre a página wiki do guia de onboarding"
AI:   Encontra a página na lista → chama wiki action=get → retorna conteúdo completo em Markdown

You:  "Leia a documentação de referência da API"
AI:   Chama wiki action=get → retorna o conteúdo completo da página

You:  "O que diz o runbook de deploy?"
AI:   Encontra a página → chama wiki action=get → resume ou exibe o conteúdo

Criando Páginas Wiki

A ação create constrói uma nova página wiki com título e conteúdo em Markdown. Páginas podem ser criadas como documentação de nível superior ou aninhadas sob uma página pai para construir estruturas hierárquicas.

Parâmetros Obrigatórios

Parameter	Type	Description
`company_slug`	string	Identificador do workspace
`project_slug`	string	Identificador do projeto
`title`	string	Título da página — descritivo e escaneável
`content`	string	Corpo da página em formato Markdown

Parâmetros Opcionais

Parameter	Type	Description
`parent_uuid`	string	UUID da página wiki pai para aninhar esta página. Omita para uma página de nível superior.

Exemplos de Prompts

You:  "Crie uma página wiki 'Guia de Onboarding' no projeto Backend com
       instruções de setup para novos desenvolvedores"
AI:   Chama wiki action=create com título e conteúdo abrangente em Markdown

You:  "Crie uma página wiki 'Referência da API REST' documentando nossos endpoints"
AI:   Chama wiki action=create com título e documentação estruturada da API

You:  "Adicione uma página filha 'Fluxo de Autenticação' na seção Arquitetura"
AI:   Encontra o UUID da página Arquitetura → chama wiki action=create com parent_uuid

You:  "Crie um runbook de deploy cobrindo procedimentos de staging e produção"
AI:   Chama wiki action=create com conteúdo detalhado passo a passo em Markdown

Estruturas de Páginas Aninhadas

Use parent_uuid para construir hierarquias de documentação. O assistente de IA pode criar estruturas inteiras em uma única conversa:

You:  "Crie uma seção wiki de Arquitetura com páginas filhas para
       Design de Banco de Dados, Camada de API e Autenticação"
AI:   1. Cria "Arquitetura" como página de nível superior
      2. Cria "Design de Banco de Dados" com parent_uuid de Arquitetura
      3. Cria "Camada de API" com parent_uuid de Arquitetura
      4. Cria "Autenticação" com parent_uuid de Arquitetura

Atualizando Páginas Wiki

A ação update modifica uma página wiki existente. Apenas os campos que você especificar são alterados — se você atualizar apenas o conteúdo, o título permanece inalterado, e vice-versa.

Parâmetros Obrigatórios

Parameter	Type	Description
`uuid`	string	UUID da página wiki
`company_slug`	string	Identificador do workspace
`project_slug`	string	Identificador do projeto

Parâmetros Opcionais

Parameter	Type	Description
`title`	string	Título atualizado da página
`content`	string	Corpo atualizado da página em formato Markdown

You:  "Atualize o guia de onboarding com as novas instruções do pipeline CI/CD"
AI:   Encontra a página → chama wiki action=update com conteúdo revisado em Markdown

You:  "Renomeie a página de docs da API para 'Referência da API REST v3'"
AI:   Chama wiki action=update com title="REST API v3 Reference"

You:  "Adicione uma seção sobre tratamento de erros na página wiki de referência da API"
AI:   Obtém conteúdo atual → adiciona nova seção → chama wiki action=update

Pesquisando Conteúdo da Wiki

A ação search realiza pesquisa por palavra-chave em todas as páginas wiki de um projeto. Os resultados incluem páginas correspondentes com seus UUIDs e títulos, permitindo navegar diretamente para a documentação relevante.

Parâmetros Obrigatórios

Parameter	Type	Description
`company_slug`	string	Identificador do workspace
`project_slug`	string	Identificador do projeto
`q`	string	Consulta de pesquisa (mínimo 2 caracteres)

Parâmetros Opcionais

Parameter	Type	Description
`limit`	number	Máximo de resultados a retornar (1-50)

You:  "Pesquise na wiki por 'migração de banco de dados'"
AI:   Chama wiki action=search com q="database migration" → retorna páginas correspondentes

You:  "Encontre páginas wiki sobre autenticação"
AI:   Chama wiki action=search com q="authentication" → lista documentação relevante

You:  "Existe documentação sobre o processo de deploy?"
AI:   Chama wiki action=search com q="deployment" → retorna páginas correspondentes ou vazio

You:  "Pesquise 'API' nos docs do projeto, mostre os 5 primeiros resultados"
AI:   Chama wiki action=search com q="API", limit=5

Padrões de Base de Conhecimento

Wikis são mais eficazes quando organizadas em torno de padrões previsíveis. Aqui estão estruturas recomendadas para projetos técnicos:

Estrutura de Documentação do Projeto

📄 Visão Geral
  📄 Arquitetura
    📄 Design de Banco de Dados
    📄 Camada de API
    📄 Autenticação
  📄 Começando
    📄 Setup Local
    📄 Variáveis de Ambiente
    📄 Executando Testes
  📄 Deploy
    📄 Runbook de Staging
    📄 Runbook de Produção
    📄 Procedimentos de Rollback
  📄 Referência da API
    📄 Endpoints
    📄 Códigos de Erro
    📄 Rate Limits

Construindo a Estrutura

Seu assistente de IA pode criar toda uma estrutura de documentação em uma conversa:

You:  "Crie uma wiki de documentação completa para o projeto Backend. Inclua
       seções para Arquitetura, Começando, Deploy e Referência da API.
       Cada seção deve ter páginas filhas relevantes."
AI:   Cria 10-15 páginas wiki com relações hierárquicas parent_uuid,
      preenchendo cada uma com conteúdo inicial

Mantendo a Documentação Atualizada

Atualize páginas conforme a base de código evolui. A ação de pesquisa ajuda a encontrar páginas que precisam de revisão:

You:  "Pesquise na wiki por referências ao endpoint antigo de auth"
AI:   Chama wiki action=search com q="auth" → identifica páginas para atualizar

You:  "Atualize todas as páginas wiki que referenciam a API v2 para apontar para v3"
AI:   Pesquisa → lê cada página → atualiza referências

Wiki vs Discussões vs NoteVault

Escolha a ferramenta certa para o tipo de conteúdo:

Aspecto	Wiki (esta ferramenta)	Discussões	NoteVault
Escopo	Documentação no nível de projeto	Conversas no nível de projeto	Notas pessoais/compartilhadas
Estrutura	Páginas hierárquicas	Comentários em threads	Notas organizadas em pastas
Ciclo de vida	Longa duração, evolui com o tempo	Aberta → fechada quando resolvida	Workspace pessoal
Melhor para	Guias de onboarding, runbooks, referências	Decisões, propostas, debates	Notas de reunião, rascunhos, rascunhos rápidos

Resolução Automática de Contexto

A ferramenta wiki suporta resolução automática de contexto. Se seu assistente de IA já conhece o workspace e o projeto de uma chamada anterior na conversa, você pode dizer "crie uma página wiki" sem especificar o projeto — o contexto é carregado adiante.

Próximos Passos

NoteVault: Gerencie notas pessoais e compartilhadas com organização por pastas.
Discussões: Crie canais de discussão com threads para decisões da equipe.
Pesquisa: Pesquise em todas as entidades do GitScrum incluindo páginas wiki.
Início Rápido: Configure o MCP server se ainda não o fez.