GitScrum / Docs

Início Rápido

Instale e configure o GitScrum MCP Server em menos de 5 minutos. Conecte Claude, Cursor ou GitHub Copilot ao seu workspace GitScrum.

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.

Coloque o GitScrum MCP Server em funcionamento em menos de 5 minutos. Ao final deste guia, seu assistente de IA terá acesso completo aos seus workspaces, projetos, tarefas, sprints e mais do GitScrum.


Pré-requisitos

Antes de começar, certifique-se de ter o seguinte:

RequisitoDetalhes
Node.jsVersão 18.0.0 ou superior. Verifique com node --version.
Conta GitScrumUma conta gratuita ou paga em gitscrum.com. Você precisa de pelo menos um workspace com um projeto.
Cliente compatível com MCPClaude Desktop, VS Code com GitHub Copilot, Cursor, Windsurf ou Continue.

Se você não tem o Node.js instalado, baixe-o em nodejs.org. A versão LTS é recomendada.


Instalação

Opção 1: Executar com npx (recomendado)

Nenhuma instalação necessária. O servidor MCP roda diretamente pelo npx, que baixa e executa a versão mais recente automaticamente:

npx -y @gitscrum-studio/mcp-server

Esta é a abordagem recomendada porque:

  • Sempre usa a versão mais recente
  • Sem pacotes globais para manter
  • Sem atualizações manuais necessárias
  • Funciona imediatamente em todos os sistemas operacionais

Opção 2: Instalação global

Se você preferir uma instalação persistente:

npm install -g @gitscrum-studio/mcp-server

Após a instalação global, o binário do servidor fica disponível como gitscrum-mcp-server no seu PATH. Para atualizar depois:

npm update -g @gitscrum-studio/mcp-server

Configure Seu Cliente

Escolha seu cliente de IA e adicione o GitScrum MCP Server à configuração dele.

Claude Desktop

Localize o arquivo de configuração do Claude Desktop:

  • macOS: ~/Library/Application Support/Claude/claudedesktopconfig.json
  • Windows: %APPDATA%\Claude\claudedesktopconfig.json

Se o arquivo não existir, crie-o. Adicione a seguinte configuração:

{
  "mcpServers": {
    "gitscrum": {
      "command": "npx",
      "args": ["-y", "@gitscrum-studio/mcp-server"]
    }
  }
}

Se você já tem outros servidores MCP configurados, adicione a entrada "gitscrum" dentro do objeto "mcpServers" existente:

{
  "mcpServers": {
    "existing-server": { ... },
    "gitscrum": {
      "command": "npx",
      "args": ["-y", "@gitscrum-studio/mcp-server"]
    }
  }
}

Reinicie o Claude Desktop após salvar o arquivo de configuração. As ferramentas GitScrum aparecem na lista de ferramentas do Claude automaticamente.

VS Code com GitHub Copilot

Crie ou edite .vscode/mcp.json na raiz do seu projeto:

{
  "servers": {
    "gitscrum": {
      "command": "npx",
      "args": ["-y", "@gitscrum-studio/mcp-server"]
    }
  }
}

Esta configuração se aplica ao workspace atual. Para acesso global em todos os projetos, adicione-a nas configurações de usuário do VS Code.

Após salvar, o GitHub Copilot detecta o servidor MCP automaticamente. Você pode verificar abrindo o Copilot Chat e perguntando sobre seu workspace GitScrum.

Cursor

Abra as Configurações do Cursor e navegue até a seção MCP, ou edite o arquivo de configuração diretamente:

  • macOS: ~/.cursor/mcp.json
  • Windows: %USERPROFILE%\.cursor\mcp.json
{
  "mcpServers": {
    "gitscrum": {
      "command": "npx",
      "args": ["-y", "@gitscrum-studio/mcp-server"]
    }
  }
}

Reinicie o Cursor após salvar. As ferramentas GitScrum aparecem na listagem de ferramentas do Cursor.

Windsurf

Adicione o seguinte à configuração MCP do Windsurf:

{
  "mcpServers": {
    "gitscrum": {
      "command": "npx",
      "args": ["-y", "@gitscrum-studio/mcp-server"]
    }
  }
}

Continue (VS Code / JetBrains)

Adicione o GitScrum ao arquivo de configuração do Continue (~/.continue/config.json):

{
  "mcpServers": [
    {
      "name": "gitscrum",
      "command": "npx",
      "args": ["-y", "@gitscrum-studio/mcp-server"]
    }
  ]
}

Autenticar

Na primeira vez que você interagir com o GitScrum MCP Server, precisa autenticar. O servidor usa OAuth 2.0 Device Authorization Grant — um fluxo seguro baseado em navegador.

Passo a passo

  1. Diga ao seu assistente de IA para fazer login. Digite algo como:

`` Fazer login no GitScrum ``

  1. O assistente de IA chama auth_login e retorna uma URL de verificação e um código de usuário. Você verá uma mensagem como:

`` Abra esta URL no seu navegador: https://gitscrum.com/device Digite o código: ABCD-1234 ``

  1. Abra a URL no seu navegador e digite o código mostrado. Faça login na sua conta GitScrum se solicitado e aprove a solicitação de acesso.
  1. Diga ao seu assistente de IA para completar a autenticação:

`` Completar o login do GitScrum ``

  1. A IA chama auth_complete e confirma que sua sessão está ativa. Seu token de autenticação é armazenado localmente em ~/.gitscrum/auth.json.

A partir deste ponto, o servidor MCP autentica automaticamente. Os tokens são atualizados em segundo plano, então você não precisará fazer login novamente, a menos que saia explicitamente ou o token expire.

Verificando sua sessão

A qualquer momento, pergunte ao seu assistente de IA:

Verificar meu status de autenticação no GitScrum

A ferramenta auth_status retorna o estado atual da sua sessão, incluindo o usuário autenticado e o acesso ao workspace.


Seus Primeiros Comandos

Agora que você está autenticado, experimente estes comandos para explorar o que o servidor MCP pode fazer:

Explore seu workspace

Listar meus workspaces do GitScrum

Retorna todos os workspaces aos quais você tem acesso, com seus slugs e detalhes.

Veja suas tarefas

Mostrar minhas tarefas para hoje

Busca tarefas atribuídas a você que vencem ou estão agendadas para hoje, em todos os projetos.

Visão geral do projeto

Mostrar os projetos no meu workspace

Lista todos os projetos no seu workspace atual com estatísticas e membros da equipe.

Crie uma tarefa

Criar uma tarefa chamada "Atualizar documentação da API" no projeto Backend com alta prioridade

Cria uma nova tarefa com o título, projeto e prioridade especificados.

Verifique o progresso do sprint

Como está o sprint atual?

Retorna KPIs do sprint, métricas de progresso e dados de burndown para o sprint ativo.

Inicie um cronômetro

Iniciar controle de tempo na tarefa PROJ-42

Inicia uma sessão de controle de tempo na tarefa especificada.

Obtenha um resumo de standup

O que a equipe completou ontem?

Gera um resumo de standup com trabalho concluído, bloqueios e atividade dos contribuidores.


O que Está Disponível

Aqui está uma referência rápida do que você pode fazer pelo servidor MCP:

CategoriaCapacidades
TarefasCriar, atualizar, completar, filtrar, duplicar, mover, ver subtarefas, ler notificações
SprintsCriar, planejar, acompanhar progresso, ver burndown, checar KPIs e velocidade
Controle de TempoIniciar/parar cronômetros, ver registros, analytics da equipe, relatórios de produtividade
User Stories e EpicsCriar, atualizar, listar, organizar backlog
Labels e TiposCriar e gerenciar labels, tipos de tarefa, vincular/desvincular de tarefas
WorkflowsCriar e atualizar estágios do workflow Kanban
WikiCriar, atualizar, pesquisar páginas de documentação
NotasCriar, compartilhar, organizar em pastas, ver histórico de revisões
DiscussõesNavegar canais, enviar mensagens, pesquisar conversas, gerenciar não lidos
ComentáriosAdicionar e atualizar comentários em tarefas e itens
PesquisaPesquisa full-text em todo o workspace
ClientFlow CRMGerenciar clientes, faturas, propostas, com relatórios de dashboard
StandupResumos automatizados de standup, bloqueios, progresso da equipe
AnalyticsRelatórios do dashboard gerencial, analytics de projetos
AtividadeFeed de atividades, feed de usuário, transições de workflow
OrçamentoProjetos em risco, acompanhamento de consumo, burn-down, alertas

Solução de Problemas

"Command not found" ou npx falha

Verifique se o Node.js está instalado e na versão 18+:

node --version

Se a versão for inferior a 18, atualize o Node.js em nodejs.org.

Servidor MCP não aparece no cliente

  • Claude Desktop: Reinicie o aplicativo após editar o arquivo de configuração. Verifique se a sintaxe JSON é válida.
  • VS Code: Certifique-se de que o arquivo .vscode/mcp.json está na raiz do workspace. Recarregue a janela (Ctrl+Shift+P → "Reload Window").
  • Cursor: Reinicie o Cursor após editar o arquivo de configuração.

Autenticação falha

  • Certifique-se de que abriu a URL de verificação correta em um navegador onde está logado no GitScrum.
  • Digite o código exatamente como mostrado (incluindo o hífen).
  • Complete o fluxo no navegador dentro de 15 minutos — os códigos de dispositivo expiram.
  • Se o código expirou, execute auth_login novamente para obter um novo código.

Erros "Unauthorized" após autenticação

Seu token pode ter expirado. Peça ao seu assistente de IA:

Sair do GitScrum e fazer login novamente

Isso limpa o token armazenado e inicia um novo fluxo de autenticação.

Rate limiting

Se você receber erros 429, o servidor está sendo limitado por taxa. Aguarde alguns minutos antes de fazer requisições adicionais. Os limites de taxa são resetados automaticamente.


Próximos Passos

  • Configuração: Configuração avançada para todos os clientes, Docker, variáveis de ambiente e argumentos personalizados.
  • Autenticação: Aprofundamento no fluxo OAuth 2.0 Device Grant, gerenciamento de tokens e segurança.
  • Segurança: Modelo de segurança enterprise, restrições de operação e boas práticas.
  • Visão Geral do MCP: Referência completa de ferramentas com todas as 29 ferramentas e mais de 160 operações.