Skip to main content

Como usar o Servidor de MCP do GitHub

Saiba como usar o servidor de MCP (Protocolo de Contexto de Modelo) do GitHub para estender o Copilot Chat.

Observação

Atualmente, o servidor de MCP do GitHub está em versão prévia pública e sujeito a alterações.

Sobre o servidor de MCP do GitHub

O servidor de MCP do GitHub é um servidor de MCP (Protocolo de Contexto de Modelo) fornecido e mantido pelo GitHub. O MCP permite que você integre recursos de IA a outras ferramentas e serviços, aprimorando sua experiência de desenvolvimento fornecendo assistência de IA com reconhecimento de contexto.

Para obter mais informações sobre o MCP, confira a documentação oficial do MCP.

Você pode acessar o servidor de MCP do GitHub remotamente por meio do Visual Studio Code ou outros editores que dão suporte ao MCP remoto; ou você pode executá-lo localmente em qualquer editor compatível com MCP, permitindo escolher entre a conveniência de uma solução hospedada ou a personalização de uma configuração auto-hospedada.

Se você quiser utilizar o servidor de MCP remoto do GitHub, poderá fazer isso em algumas etapas, sem nenhuma configuração local. Isso é particularmente útil para usuários que desejam aproveitar rapidamente as funcionalidades de IA do GitHub sem a sobrecarga de gerenciar um servidor de MCP local.

Executar o servidor de MCP do GitHub localmente requer um pouco mais de configuração, mas permite uma maior personalização e controle sobre suas interações de IA.

O servidor de MCP do GitHub pode ser usado para:

  • Automatizar e simplificar tarefas relacionadas ao código.
  • Conectar ferramentas de terceiros (como Cursor, Windsurf ou integrações futuras) para aproveitar o contexto e as funcionalidades de IA do GitHub.
  • Habilitar fluxos de trabalho baseados em nuvem que funcionam em qualquer dispositivo, sem configuração local.

Disponibilidade

Atualmente, há amplo suporte para servidores de MCP locais em clientes como Visual Studio Code, IDEs do JetBrains, XCode e outros.

O suporte para servidores de MCP remotos está se ampliando, com editores como Visual Studio Code (com OAuth ou PAT), Visual Studio (somente PAT), Windsurf (somente PAT) e Cursor (somente PAT) já fornecendo essa funcionalidade.

Para descobrir se seu editor preferencial dá suporte a servidores de MCP remotos, verifique a documentação do editor específico.

Pré-requisitos

  • Uma conta do GitHub.
  • Visual Studio Code ou outro editor compatível com MCP.

Como configurar o servidor de MCP do GitHub no Visual Studio Code

As instruções abaixo orientam você na configuração do servidor de MCP do GitHub no Visual Studio Code. Outros editores compatíveis com MCP podem ter etapas semelhantes, mas o processo exato pode variar.

Você pode optar por configurar o servidor de MCP do GitHub remotamente ou localmente, dependendo de suas necessidades e preferências. Você também pode configurar o servidor de MCP do GitHub para:

  • Um repositório específico. Isso permite que você compartilhe servidores de MCP com qualquer pessoa que abra o projeto no Visual Studio Code. Para fazer isso, crie um arquivo .vscode/mcp.json na raiz do repositório.
  • Sua instância pessoal do Visual Studio Code. Você será a única pessoa que terá acesso a servidores MCP configurados. Para fazer isso, adicione a configuração ao arquivo settings.json no Visual Studio Code. Os servidores de MCP configurados dessa forma ficarão disponíveis em todos os workspaces.

O servidor de MCP remoto do GitHub usa a autenticação OAuth com um clique por padrão, mas você também pode configurá-la manualmente para usar um PAT (personal access token) para autenticação. Se você usar o OAuth, o servidor de MCP terá o mesmo acesso que sua conta pessoal. Se você usar um PAT, o servidor de MCP terá acesso aos escopos concedidos pelo PAT.

Observação

Se você for um Enterprise Managed User com restrições de PAT, não poderá usar a autenticação do PAT. Se você tiver restrições de política de acesso do OAuth, precisará que os aplicativos de OAuth para cada cliente sejam habilitados (exceto o Visual Studio Code e Visual Studio).

Configuração remota do servidor de MCP com OAuth

Observação

O servidor de MCP remoto do GitHub não está disponível para os usuários do GitHub Enterprise Server. Se você estiver usando o GitHub Enterprise Server, poderá instalar o servidor de MCP do GitHub localmente. Consulte a configuraçãodo servidor de MCP local.

Você não precisa criar um PAT nem instalar software adicional para usar o servidor de MCP remoto do GitHub com o OAuth. Você pode configurá-lo diretamente no Visual Studio Code. Você também pode instalar conjuntos de ferramentas individuais, no modo somente leitura ou com acesso total de leitura/gravação, permitindo adaptar os recursos do servidor às suas necessidades específicas. Para obter mais informações, confira Configuração da ferramenta.

  1. No Visual Studio Code, abra a paleta de comandos pressionando Ctrl+Shift+P (Windows/Linux)/Command+Shift+P (Mac).

  2. Digite mcp: add server e pressione Enter.

  3. Na lista, selecione HTTP (Eventos enviados por HTTP ou Servidor).

  4. No campo URL do Servidor, insira https://api.githubcopilot.com/mcp/ e pressione Enter.

  5. Em Inserir ID do Servidor, pressione Enter para usar a ID do servidor padrão ou insira uma ID de servidor personalizada.

  6. Em Escolher onde salvar a configuração, selecione onde deseja salvar a configuração do servidor de MCP.

    • O Visual Studio Code se abrirá e adicionará a configuração ao arquivo selecionado no editor ou criará um arquivo se ele não existir.
  7. No pop-up do Visual Studio Code, para autorizar o servidor de MCP com o OAuth, clique em Permitir e selecione sua conta pessoal na lista.

Configuração remota do servidor de MCP com PAT

Para configurar o servidor de MCP remoto do GitHub com um PAT, verifique se você criou o PAT com os escopos necessários para o acesso que deseja conceder ao servidor de MCP. Para saber mais, confira Gerenciar seus tokens de acesso pessoal.

Você precisará configurar manualmente o servidor de MCP no Visual Studio Code para usar o PAT para autorização.

  1. No Visual Studio Code, abra a paleta de comandos pressionando Ctrl+Shift+P (Windows/Linux)/Command+Shift+P (Mac).

  2. Digite mcp: add server e pressione Enter.

  3. Na lista, selecione HTTP (Eventos enviados por HTTP ou Servidor).

  4. No campo URL do Servidor, insira https://api.githubcopilot.com/mcp/ e pressione Enter.

  5. Em Inserir ID do Servidor, pressione Enter para usar a ID do servidor padrão ou insira uma ID de servidor personalizada.

  6. Em Escolher onde salvar a configuração, selecione onde deseja salvar a configuração do servidor de MCP.

    • O Visual Studio Code se abrirá e adicionará a configuração ao arquivo selecionado no editor ou criará um arquivo se ele não existir.
  7. No pop-up do Visual Studio Code, para recusar a autorização do OAuth, clique em Cancelar.

  8. Você precisará editar manualmente o arquivo de configuração para usar um PAT. No arquivo de configuração, no final da linha url, adicione o seguinte:

    JSON
        ,
          "headers": {
            "Authorization": "Bearer ${input:github_token}"
          }
        },
      },
      "inputs": [
        {
          "id": "github_token",
          "type": "promptString",
          "description": "GitHub Personal Access Token",
          "password": true
        }
      ]
    }
    
  9. Um botão "Reiniciar" será exibido no arquivo. Clique em "Reiniciar" para reiniciar o servidor de MCP com a nova configuração.

    Captura de tela do botão de reinicialização do servidor de MCP no arquivo de configuração. O botão "Reiniciar" está contornado em laranja escuro.

  10. Na paleta de comandos, você verá uma solicitação para inserir o token do GitHub. Insira o PAT criado anteriormente e pressione Enter.

    • O servidor de MCP agora será configurado para usar o PAT para autorização.

Configuração do servidor de MCP local

Observação

Se você for um usuário do GitHub Enterprise Server e sua empresa tiver restrições de PAT habilitadas, você só poderá usar pontos de extremidade de API para escopos permitidos pela política de PAT da sua empresa. Se todos os pontos de extremidade de API forem restritos, você não poderá usar o servidor de MCP. Se você não tiver certeza sobre a política de PAT da sua empresa, entre em contato com o administrador para obter mais informações.

Usar o servidor de MCP do GitHub localmente exige que você tenha o Docker instalado e em execução em seu computador. Além disso, você só pode se autenticar com um PAT, pois o OAuth não tem suporte para servidores de MCP locais.

  1. Você precisa ter o Docker instalado e em execução em seu computador. Confira Instruções de instalação do Docker.

  2. Crie um PAT com (pelo menos) os escopos read:packages e repo. Para saber mais, confira Gerenciar seus tokens de acesso pessoal.

  3. Decida se deseja configurar o servidor de MCP para um repositório específico ou para sua instância pessoal do Visual Studio Code.

    • Se você estiver usando um repositório específico, abra o arquivo .vscode/mcp.json no Visual Studio Codee adicione a seguinte configuração:
    JSON
       {
        "inputs": [
          {
            "type": "promptString",
            "id": "github_token",
            "description": "GitHub Personal Access Token",
            "password": true
          }
        ],
        "servers": {
          "github": {
            "command": "docker",
            "args": [
              "run",
              "-i",
              "--rm",
              "-e",
              "GITHUB_PERSONAL_ACCESS_TOKEN",
              "ghcr.io/github/github-mcp-server"
            ],
            "env": {
              "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}"
            }
          }
        }
      }
    
    • Se você estiver usando sua instância pessoal do Visual Studio Code, abra o arquivo settings.json no Visual Studio Code:
      • Pressione Ctrl+Shift+P (Windows/Linux) ou Cmd+Shift+P (macOS).
      • Digite Preferências: Abrir Configurações (JSON) e selecione-a.
      • Adicione a seguinte configuração:
    JSON
    {
      "mcp": {
        "inputs": [
          {
            "type": "promptString",
            "id": "github_token",
            "description": "GitHub Personal Access Token",
            "password": true
          }
        ],
        "servers": {
          "github": {
            "command": "docker",
            "args": [
              "run",
              "-i",
              "--rm",
              "-e",
              "GITHUB_PERSONAL_ACCESS_TOKEN",
              "ghcr.io/github/github-mcp-server"
            ],
            "env": {
              "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}"
            }
          }
        }
      }
    }
    
  4. Salve o arquivo.

  5. Na paleta de comandos, você verá um prompt para inserir o token do GitHub. Insira o PAT criado anteriormente e pressione Enter.

    • O servidor de MCP agora será configurado para ser executado localmente com o PAT para autorização.

Configuração da ferramenta

O servidor de MCP do GitHub dá suporte à instalação de conjuntos de ferramentas individuais, no modo somente leitura ou com acesso total de leitura/gravação, permitindo que você adapte os recursos do servidor às suas necessidades específicas. Se você deseja opções de instalação com um clique de cada conjunto de ferramentas, consulte o repositório de servidores de MCP do GitHub.

Como usar o servidor de MCP do GitHub no Visual Studio Code

O servidor de MCP do GitHub permite que você execute uma ampla gama de ações no GitHub, por meio do Copilot Chat no Visual Studio Code.

  1. Abra o Copilot Chat clicando no ícone na barra de título do Visual Studio Code.
  2. Na caixa do Copilot Chat, selecione Agent no menu pop-up.
  3. Para ver as ações disponíveis, na caixa Copilot Chat, clique no ícone Selecionar ferramentas.
    • Na lista suspensa Ferramentas, em Servidor de MCP:GitHub, você verá uma lista de ações disponíveis.
  4. Na caixa Copilot Chat, digite um comando ou pergunta relacionado à ação que deseja executar e pressione Enter.
    • Por exemplo, você pode solicitar ao servidor de MCP do GitHub para criar um novo Issue, listar pull requests ou recuperar informações do repositório.
  5. O servidor de MCP do GitHub processará sua solicitação e fornecerá uma resposta na interface de chat.
    • Na caixa do Copilot Chat, você pode ser solicitado a conceder permissões adicionais ou fornecer mais informações para concluir a ação.
  6. Siga as instruções para concluir a ação.

Solução de problemas

Se você tiver problemas ao usar o servidor de MCP do GitHub, há algumas etapas comuns de solução de problemas que você pode executar.

Problemas de autorização

Se você estiver tendo problemas para autorizar o servidor de MCP, verifique se:

  • Você está conectado ao GitHub no IDE que você escolheu.

Se você estiver autenticando com um PAT (personal access token), verifique se:

  • Seu PAT do GitHub é válido e tem os escopos necessários para as ações que você deseja executar.
  • Você inseriu o PAT correto quando solicitado no Visual Studio Code.

Problemas no modo do agente do Copilot

Se você estiver tendo problemas com o modo de agente do Copilot Chat, verifique se:

  • Você selecionou o agente correto na caixa do Copilot Chat.
  • Você configurou o servidor de MCP corretamente no Visual Studio Code.
  • Você tem as permissões necessárias para as ações que está tentando executar.

Dicas gerais

Se você estiver enfrentando outros problemas com o servidor de MCP do GitHub, aqui estão algumas dicas gerais para ajudar a solucionar problemas:

  • Verifique os logs de saída do servidor de MCP em busca de mensagens de erro.
  • Se você estiver executando o servidor de MCP localmente, verifique se o ambiente local está configurado corretamente para executar contêineres do Docker.
  • Tente reiniciar o servidor de MCP ou o IDE.

Leitura adicional