Skip to main content

Configurando o servidor MCP GitHub para GitHub Enterprise

Saiba como configurar o servidor do Protocolo de Contexto de Modelo (MCP) do GitHub para trabalhar com GitHub Enterprise Server ou GitHub Enterprise Cloud com residência de dados.

O servidor GitHub MCP pode ser configurado para trabalhar com GitHub Enterprise Server e GitHub Enterprise Cloud com residência de dados. As etapas de configuração diferem dependendo se você está usando o servidor MCP remoto ou local.

Sobre a configuração do servidor MCP empresarial

O servidor GitHub MCP dá suporte a dois tipos de implantação empresarial:

  •           **              [GitHub Enterprise Cloud com residência de dados](#configuring-the-remote-mcp-server-for-github-enterprise-cloud-with-data-residency)**: dá suporte a configurações de servidor MCP remoto e local.
    
  •         **
            [GitHub Enterprise Server](#configuring-the-local-mcp-server-for-enterprise)**: dá suporte **somente à configuração do servidor MCP local**
    

Importante

O GitHub Enterprise Server não dá suporte à hospedagem remota de servidores MCP. Se você estiver usando o GitHub Enterprise Server, deverá usar a configuração do servidor MCP local descrita na Configuração do servidor MCP local para uso empresarial. Ignore a seção de configuração remota do servidor MCP abaixo.

Pré-requisitos

  • Uma instância do GitHub Enterprise Server ou do GitHub Enterprise Cloud com residência de dados
  • O servidor GitHub MCP configurado em seu editor. Consulte Configurando o servidor MCP GitHub.

Configurando o servidor MCP remoto para GitHub Enterprise Cloud com residência de dados

Observação

Esta seção se aplica somente a GitHub Enterprise Cloud com residência de dados. Se você estiver usando o GitHub Enterprise Server, vá para Configuração do servidor MCP local para empresas.

GitHub Enterprise Cloud com residência de dados pode usar o servidor MCP remoto. Para configurá-lo, você precisa atualizar a URL do servidor MCP para direcioná-lo à sua instância do GitHub Enterprise Cloud.

Por exemplo, se a instância do GitHub Enterprise Cloud for https://octocorp.ghe.com, a URL do servidor MCP será https://copilot-api.octocorp.ghe.com/mcp.

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

  2. Digite e selecione MCP: Abrir Configuração do Usuário.

  3. No arquivo de configurações, localize a servers seção. Se você já tiver configurado o servidor GitHub MCP, verá uma entrada github.

  4. Atualize o campo url para apontar para a instância do GitHub Enterprise Cloud.

           **Opção A: com autenticação pat**
    
    JSON
    {
      "servers": {
        "github": {
          "type": "http",
          "url": "https://copilot-api.SUBDOMAIN.ghe.com/mcp",
          "headers": {
            "Authorization": "Bearer ${input:github_mcp_pat}"
          }
        }
      },
      "inputs": [
        {
          "type": "promptString",
          "id": "github_mcp_pat",
          "description": "GitHub PAT",
          "password": true
        }
      ]
    }
    
           **Opção B: com autenticação OAuth**
    
    JSON
    {
      "servers": {
        "github": {
          "type": "http",
          "url": "https://copilot-api.SUBDOMAIN.ghe.com/mcp"
        }
      }
    }
    

    Substitua SUBDOMAIN.ghe.com pelo subdomínio do GHE.com.

  5. Salve o arquivo.

  6. Ao usar o OAuth com GitHub Enterprise Cloud com residência de dados, defina as configurações do VS Code para apontar para sua instância do GitHub Enterprise Cloud. Adicione o seguinte às configurações de usuário do VS Code:

    {
      "github-enterprise.uri": "https://copilot-api.SUBDOMAIN.ghe.com/mcp"
    }
    
  7. Reinicie Visual Studio Code ou recarregue a janela para que as alterações tenham efeito.

GitHub Enterprise Cloud pode usar o servidor MCP remoto com residência de dados. Para configurá-lo, você precisa atualizar a URL do servidor MCP para direcioná-lo à sua instância do GitHub Enterprise Cloud.

Por exemplo, se a instância do GitHub Enterprise Cloud for https://octocorp.ghe.com, a URL do servidor MCP será https://copilot-api.octocorp.ghe.com/mcp.

  1. Na barra de menus do Visual Studio, clique em Exibir e depois em Chat GitHub Copilot.
  2. Na parte inferior do painel de chat, selecione Agent na lista suspensa de modo.
  3. Na janela Chat Copilot, clique no ícone de ferramentas e no ícone de adição na janela do seletor de ferramentas.
  4. Na janela pop-up "Configure MCP server", preencha os campos.
    1. Para "ID do servidor", digite github.
    2. Para "Type", selecione "HTTP/SSE" na lista suspensa.
    3. Para "URL", digite https://copilot-api.YOURSUBDOMAIN.ghe.com/mcp, substituindo YOURSUBDOMAIN pelo subdomínio GitHub Enterprise Cloud.
    4. Adicione um novo cabeçalho a "Headers", chame-o de "Authorization" e defina o valor como Bearer YOUR_GITHUB_PAT, substituindo "YOUR_GITHUB_PAT" pelo personal access token.
  5. Clique em Salvar.

GitHub Enterprise Cloud pode usar o servidor MCP remoto com residência de dados. Para configurá-lo, você precisa atualizar a URL do servidor MCP para direcioná-lo à sua instância do GitHub Enterprise Cloud.

Por exemplo, se a instância do GitHub Enterprise Cloud for https://octocorp.ghe.com, a URL do servidor MCP será https://copilot-api.octocorp.ghe.com/mcp.

  1. No canto inferior direito, clique em .

  2. No menu, selecione "Open Chat", verifique se você está no modo agente e clique no ícone de ferramentas (chamado "Configure your MCP server") na parte inferior da janela de chat.

  3. Clique em Add MCP Tools.

  4. No arquivo mcp.json, adicione a seguinte configuração, substituindo YOURSUBDOMAIN pelo subdomínio GitHub Enterprise Cloud e YOUR_GITHUB_PAT por personal access token:

    JSON
    {
      "servers": {
        "github": {
          "url": "https://copilot-api.YOURSUBDOMAIN.ghe.com/mcp",
          "requestInit": {
            "headers": {
              "Authorization": "Bearer YOUR_GITHUB_PAT"
            }
          }
        }
      }
    }
    

GitHub Enterprise Cloud pode usar o servidor MCP remoto com residência de dados. Para configurá-lo, você precisa atualizar a URL do servidor MCP para direcioná-lo à sua instância do GitHub Enterprise Cloud.

Por exemplo, se a instância do GitHub Enterprise Cloud for https://octocorp.ghe.com, a URL do servidor MCP será https://copilot-api.octocorp.ghe.com/mcp.

  1. Abra o GitHub Copilot para a extensão do Xcode e acesse "Configurações".

    • Como alternativa, em um workspace ativo do Xcode, você pode encontrar as configurações clicando em Editor na barra de menus, selecionando GitHub Copilot e clicando em Abrir GitHub Copilot para Configurações do Xcode.
  2. Selecione a guia MCP e clique em Editar Configuração.

  3. Adicione a configuração a seguir, substituindo YOURSUBDOMAIN pelo subdomínio do GitHub Enterprise Cloud e YOUR_GITHUB_PAT por personal access token:

    JSON
    {
      "servers": {
        "github": {
          "url": "https://copilot-api.YOURSUBDOMAIN.ghe.com/mcp",
          "requestInit": {
            "headers": {
              "Authorization": "Bearer YOUR_GITHUB_PAT"
            }
          }
        }
      }
    }
    

GitHub Enterprise Cloud pode usar o servidor MCP remoto com residência de dados. Para configurá-lo, você precisa atualizar a URL do servidor MCP para direcioná-lo à sua instância do GitHub Enterprise Cloud.

Por exemplo, se a instância do GitHub Enterprise Cloud for https://octocorp.ghe.com, a URL do servidor MCP será https://copilot-api.octocorp.ghe.com/mcp.

  1. Clique no ícone Copilot () na barra de status na parte inferior do Eclipse.

  2. No menu, selecione Abrir Chat e, na janela de chat, clique no ícone "Configurar Ferramentas...".

    • Como alternativa, você pode selecionar Editar preferências e, em seguida, no painel à esquerda, expandir GitHub Copilot e clicar em MCP.
  3. Adicione a seguinte configuração em "Configurações do Servidor", substituindo YOURSUBDOMAIN pelo subdomínio GitHub Enterprise Cloud e YOUR_GITHUB_PAT pelo personal access token:

    JSON
    {
      "servers": {
        "github": {
          "url": "https://copilot-api.YOURSUBDOMAIN.ghe.com/mcp",
          "requestInit": {
            "headers": {
              "Authorization": "Bearer YOUR_GITHUB_PAT"
            }
          }
        }
      }
    }
    
  4. Clique em Aplicar.

Configurando o servidor MCP local para empresas

Tanto GitHub Enterprise Server quanto GitHub Enterprise Cloud com suporte para residência de dados dão suporte ao servidor MCP local. Você pode configurar o servidor local usando a GITHUB_HOST variável de ambiente ou o --gh-host sinalizador de linha de comando.

Considerações importantes

  •         **Para GitHub Enterprise Server**: prefixe o nome do host com o esquema de URI `https://`, caso contrário, ele será definido como `http://`, ao qual o GitHub Enterprise Server não dá suporte.
    
  •         **Para GitHub Enterprise Cloud com residência de dados**: Use `https://YOURSUBDOMAIN.ghe.com` como o nome do host.
    

Configuração com o Docker

Para configurar o servidor local MCP com Docker, no Visual Studio Code:

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

  2. Digite e selecione MCP: Abrir Configuração do Usuário.

  3. No arquivo de configurações, localize a seção servers ou crie-a se ela não existir.

  4. Adicione a seguinte configuração:

           **Para o GitHub Enterprise Server:**
    
    JSON
    {
      "inputs": [
        {
          "type": "promptString",
          "id": "github_token",
          "description": "GitHub PAT",
          "password": true
        }
      ],
      "servers": {
        "github": {
          "command": "docker",
          "args": [
            "run",
            "-i",
            "--rm",
            "-e",
            "GITHUB_PERSONAL_ACCESS_TOKEN",
            "-e",
            "GITHUB_HOST",
            "ghcr.io/github/github-mcp-server"
          ],
          "env": {
            "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
            "GITHUB_HOST": "https://YOUR_GHES_HOSTNAME"
          }
        }
      }
    }
    

    Substitua YOUR_GHES_HOSTNAME pelo nome do host GitHub Enterprise Server (por exemplo, https://github.example.com).

           **Para o GitHub Enterprise Cloud com residência de dados:**
    
    JSON
    {
      "inputs": [
        {
          "type": "promptString",
          "id": "github_token",
          "description": "GitHub PAT",
          "password": true
        }
      ],
      "servers": {
        "github": {
          "command": "docker",
          "args": [
            "run",
            "-i",
            "--rm",
            "-e",
            "GITHUB_PERSONAL_ACCESS_TOKEN",
            "-e",
            "GITHUB_HOST",
            "ghcr.io/github/github-mcp-server"
          ],
          "env": {
            "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
            "GITHUB_HOST": "https://YOURSUBDOMAIN.ghe.com"
          }
        }
      }
    }
    

    Substitua YOURSUBDOMAIN pelo subdomínio do GitHub Enterprise Cloud.

  5. Salve o arquivo.

  6. Reinicie Visual Studio Code ou recarregue a janela para que as alterações tenham efeito.

Para configurar o servidor MCP local com Docker no Visual Studio, você precisa editar manualmente o arquivo mcp.json.

  1. Abra o arquivo mcp.json no Visual Studio. O arquivo normalmente está localizado no diretório de perfil do usuário.

  2. Adicione a seguinte configuração:

           **Para o GitHub Enterprise Server:**
    
    JSON
    {
      "mcp": {
        "inputs": [
          {
            "type": "promptString",
            "id": "github_token",
            "description": "GitHub PAT",
            "password": true
          }
        ],
        "servers": {
          "github": {
            "command": "docker",
            "args": [
              "run",
              "-i",
              "--rm",
              "-e",
              "GITHUB_PERSONAL_ACCESS_TOKEN",
              "-e",
              "GITHUB_HOST",
              "ghcr.io/github/github-mcp-server"
            ],
            "env": {
              "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
              "GITHUB_HOST": "https://YOUR_GHES_HOSTNAME"
            }
          }
        }
      }
    }
    

    Substitua YOUR_GHES_HOSTNAME pelo nome do host GitHub Enterprise Server (por exemplo, https://github.example.com).

           **Para o GitHub Enterprise Cloud com residência de dados:**
    
    JSON
    {
      "mcp": {
        "inputs": [
          {
            "type": "promptString",
            "id": "github_token",
            "description": "GitHub PAT",
            "password": true
          }
        ],
        "servers": {
          "github": {
            "command": "docker",
            "args": [
              "run",
              "-i",
              "--rm",
              "-e",
              "GITHUB_PERSONAL_ACCESS_TOKEN",
              "-e",
              "GITHUB_HOST",
              "ghcr.io/github/github-mcp-server"
            ],
            "env": {
              "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
              "GITHUB_HOST": "https://YOURSUBDOMAIN.ghe.com"
            }
          }
        }
      }
    }
    

    Substitua YOURSUBDOMAIN pelo subdomínio do GitHub Enterprise Cloud.

  3. Salve o arquivo.

Para configurar o servidor MCP local com o Docker em IDEs do JetBrains:

  1. No canto inferior direito, clique em .

  2. No menu, selecione "Open Chat", verifique se você está no modo agente e clique no ícone de ferramentas (chamado "Configure your MCP server") na parte inferior da janela de chat.

  3. Clique em Add MCP Tools.

  4. Adicione a seguinte configuração:

           **Para o GitHub Enterprise Server:**
    
    JSON
    {
      "inputs": [
        {
          "type": "promptString",
          "id": "github_token",
          "description": "GitHub PAT",
          "password": true
        }
      ],
      "servers": {
        "github": {
          "command": "docker",
          "args": [
            "run",
            "-i",
            "--rm",
            "-e",
            "GITHUB_PERSONAL_ACCESS_TOKEN",
            "-e",
            "GITHUB_HOST",
            "ghcr.io/github/github-mcp-server"
          ],
          "env": {
            "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
            "GITHUB_HOST": "https://YOUR_GHES_HOSTNAME"
          }
        }
      }
    }
    

    Substitua YOUR_GHES_HOSTNAME pelo nome do host GitHub Enterprise Server (por exemplo, https://github.example.com).

           **Para o GitHub Enterprise Cloud com residência de dados:**
    
    JSON
    {
      "inputs": [
        {
          "type": "promptString",
          "id": "github_token",
          "description": "GitHub PAT",
          "password": true
        }
      ],
      "servers": {
        "github": {
          "command": "docker",
          "args": [
            "run",
            "-i",
            "--rm",
            "-e",
            "GITHUB_PERSONAL_ACCESS_TOKEN",
            "-e",
            "GITHUB_HOST",
            "ghcr.io/github/github-mcp-server"
          ],
          "env": {
            "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
            "GITHUB_HOST": "https://YOURSUBDOMAIN.ghe.com"
          }
        }
      }
    }
    

    Substitua YOURSUBDOMAIN pelo subdomínio do GitHub Enterprise Cloud.

Para configurar o servidor MCP local com o Docker no Xcode:

  1. Abra o GitHub Copilot para a extensão do Xcode e acesse "Configurações".

    • Como alternativa, em um workspace ativo do Xcode, você pode encontrar as configurações clicando em Editor na barra de menus, selecionando GitHub Copilot e clicando em Abrir GitHub Copilot para Configurações do Xcode.
  2. Selecione a guia MCP e clique em Editar Configuração.

  3. Adicione a seguinte configuração:

           **Para o GitHub Enterprise Server:**
    
    JSON
    {
      "inputs": [
        {
          "type": "promptString",
          "id": "github_token",
          "description": "GitHub PAT",
          "password": true
        }
      ],
      "servers": {
        "github": {
          "command": "docker",
          "args": [
            "run",
            "-i",
            "--rm",
            "-e",
            "GITHUB_PERSONAL_ACCESS_TOKEN",
            "-e",
            "GITHUB_HOST",
            "ghcr.io/github/github-mcp-server"
          ],
          "env": {
            "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
            "GITHUB_HOST": "https://YOUR_GHES_HOSTNAME"
          }
        }
      }
    }
    

    Substitua YOUR_GHES_HOSTNAME pelo nome do host GitHub Enterprise Server (por exemplo, https://github.example.com).

           **Para o GitHub Enterprise Cloud com residência de dados:**
    
    JSON
    {
      "inputs": [
        {
          "type": "promptString",
          "id": "github_token",
          "description": "GitHub PAT",
          "password": true
        }
      ],
      "servers": {
        "github": {
          "command": "docker",
          "args": [
            "run",
            "-i",
            "--rm",
            "-e",
            "GITHUB_PERSONAL_ACCESS_TOKEN",
            "-e",
            "GITHUB_HOST",
            "ghcr.io/github/github-mcp-server"
          ],
          "env": {
            "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
            "GITHUB_HOST": "https://YOURSUBDOMAIN.ghe.com"
          }
        }
      }
    }
    

    Substitua YOURSUBDOMAIN pelo subdomínio do GitHub Enterprise Cloud.

Para configurar o servidor MCP local com o Docker no Eclipse:

  1. Clique no ícone Copilot () na barra de status na parte inferior do Eclipse.

  2. No menu, selecione Abrir Chat e, na janela de chat, clique no ícone "Configurar Ferramentas...".

    • Como alternativa, você pode selecionar Editar preferências e, em seguida, no painel à esquerda, expandir GitHub Copilot e clicar em MCP.
  3. Adicione a seguinte configuração em "Server Configurations":

           **Para o GitHub Enterprise Server:**
    
    JSON
    {
      "inputs": [
        {
          "type": "promptString",
          "id": "github_token",
          "description": "GitHub PAT",
          "password": true
        }
      ],
      "servers": {
        "github": {
          "command": "docker",
          "args": [
            "run",
            "-i",
            "--rm",
            "-e",
            "GITHUB_PERSONAL_ACCESS_TOKEN",
            "-e",
            "GITHUB_HOST",
            "ghcr.io/github/github-mcp-server"
          ],
          "env": {
            "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
            "GITHUB_HOST": "https://YOUR_GHES_HOSTNAME"
          }
        }
      }
    }
    

    Substitua YOUR_GHES_HOSTNAME pelo nome do host GitHub Enterprise Server (por exemplo, https://github.example.com).

           **Para o GitHub Enterprise Cloud com residência de dados:**
    
    JSON
    {
      "inputs": [
        {
          "type": "promptString",
          "id": "github_token",
          "description": "GitHub PAT",
          "password": true
        }
      ],
      "servers": {
        "github": {
          "command": "docker",
          "args": [
            "run",
            "-i",
            "--rm",
            "-e",
            "GITHUB_PERSONAL_ACCESS_TOKEN",
            "-e",
            "GITHUB_HOST",
            "ghcr.io/github/github-mcp-server"
          ],
          "env": {
            "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
            "GITHUB_HOST": "https://YOURSUBDOMAIN.ghe.com"
          }
        }
      }
    }
    

    Substitua YOURSUBDOMAIN pelo subdomínio do GitHub Enterprise Cloud.

  4. Clique em Aplicar.

Configuração ao compilar a partir da origem

Se você estiver criando o servidor MCP da origem em vez de usar o Docker, poderá definir a GITHUB_HOST variável de ambiente ou usar o --gh-host sinalizador de linha de comando:

          **Usando a variável de ambiente:**
export GITHUB_HOST="https://YOUR_GHES_OR_GHEC_HOSTNAME"
./github-mcp-server stdio
          **Usando o sinalizador de linha de comando:**
./github-mcp-server --gh-host \
  "https://YOUR_GHES_OR_GHEC_HOSTNAME" stdio

Substitua YOUR_GHES_OR_GHEC_HOSTNAME pelo nome do host GitHub Enterprise Server (por exemplo, https://github.example.com) ou GitHub Enterprise Cloud host (por exemplo, https://octocorp.ghe.com).

Próximas etapas