Configurando o servidor MCP GitHub para GitHub Enterprise

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

Tool navigation

Neste artigo

O GitHub servidor 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 GitHub servidor MCP dá suporte a dois tipos de implantação empresarial:

Importante

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

Pré-requisitos

  • Uma GitHub Enterprise Server instância ou GitHub Enterprise Cloud conta com residência de dados
  • O servidor MCP GitHub configurado no 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 GitHub Enterprise Server, pule para Configuração do servidor MCP local para a empresa.

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 apontar para sua GitHub Enterprise Cloud instância.

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

  1. Em 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 GitHub servidor MCP, verá uma github entrada.

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

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 GHE.com subdomínio.

  1. Salve o arquivo.

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

    {
  "github-enterprise.uri": "https://copilot-api.SUBDOMAIN.ghe.com/mcp"
}

  3. Reinicie Visual Studio Code ou recarregue a janela para que as alterações entrem em vigor.

GitHub Enterprise Cloud que cumprem os requisitos de residência de dados pode usar o servidor MCP remoto. Para configurá-lo, você precisa atualizar a URL do servidor MCP para apontar para sua GitHub Enterprise Cloud instância.

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

  1. Na barra de Visual Studio menus, clique em Exibir e, em seguida, clique em Copilot Chat do GitHub.
  2. Na parte inferior do painel de chat, selecione Agent na lista suspensa de modo.
  3. Na janela Bate-papo do Copilot, clique no ícone de ferramentas, depois clique no ícone de mais 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 GitHub Enterprise Cloud subdomínio.
    4. Adicione um novo cabeçalho em "Headers", chamado "Authorization" e definido como o valor Bearer YOUR_GITHUB_PAT, substituindo "YOUR_GITHUB_PAT" por personal access token.
  5. Clique em Salvar.

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

Por exemplo, se sua GitHub Enterprise Cloud instância 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. mcp.json No arquivo, adicione a seguinte configuração, substituindo YOURSUBDOMAIN pelo subdomínio GitHub Enterprise Cloud e YOUR_GITHUB_PAT pelo seupersonal access token:

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

GitHub Enterprise Cloud que cumprem os requisitos de residência de dados pode usar o servidor MCP remoto. Para configurá-lo, você precisa atualizar a URL do servidor MCP para apontar para sua GitHub Enterprise Cloud instância.

Por exemplo, se sua GitHub Enterprise Cloud instância 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 seguinte configuração, substituindo YOURSUBDOMAIN pelo seu GitHub Enterprise Cloud subdomínio e YOUR_GITHUB_PAT pelo seu personal access token:

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

GitHub Enterprise Cloud que cumprem os requisitos de residência de dados pode usar o servidor MCP remoto. Para configurá-lo, você precisa atualizar a URL do servidor MCP para apontar para sua GitHub Enterprise Cloud instância.

Por exemplo, se sua GitHub Enterprise Cloud instância 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 seu GitHub Enterprise Cloud subdomínio e YOUR_GITHUB_PAT pelo seu 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 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**: adicione o prefixo ao nome do host com o esquema de URI `https://`, caso contrário, ele assumirá como padrão `http://`, que 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 MCP local com o Docker em Visual Studio Code:

  1. Em 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 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 GitHub Enterprise Server do host (por exemplo, https://github.example.com).

Para 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 GitHub Enterprise Cloud subdomínio.

  1. Salve o arquivo.
  2. Reinicie Visual Studio Code ou recarregue a janela para que as alterações entrem em vigor.

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

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

  2. Adicione a seguinte configuração:

Para 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 GitHub Enterprise Server do host (por exemplo, https://github.example.com).

Para 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 GitHub Enterprise Cloud subdomínio.

  1. 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 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 GitHub Enterprise Server do host (por exemplo, https://github.example.com).

Para 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 GitHub Enterprise Cloud subdomínio.

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 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 GitHub Enterprise Server do host (por exemplo, https://github.example.com).

Para 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 GitHub Enterprise Cloud subdomínio.

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 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 GitHub Enterprise Server do host (por exemplo, https://github.example.com).

Para 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 GitHub Enterprise Cloud subdomínio.

  1. 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 (por exemplo, https://octocorp.ghe.com).

Próximas Etapas