docs/content/copilot/how-tos/provide-context/use-mcp/enterprise-configuration.md at repo-sync

mirror of synced 2025-12-22 03:16:52 -05:00

Files

Tony Truong ee336a50f7 updating mcp docs (#58153 )

Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>

2025-12-15 13:34:32 +00:00

21 KiB

Raw Permalink Blame History

title, intro, shortTitle, versions, defaultTool, topics, contentType

title

intro

shortTitle

versions

defaultTool

topics

contentType

Configuring the GitHub MCP Server for GitHub Enterprise

Learn how to configure the GitHub Model Context Protocol (MCP) server to work with {% data variables.product.prodname_ghe_server %} or {% data variables.enterprise.data_residency %}.

Enterprise configuration

feature
copilot

vscode

Copilot

how-tos

The {% data variables.product.github %} MCP server can be configured to work with {% data variables.product.prodname_ghe_server %} and {% data variables.enterprise.data_residency %}. The configuration steps differ depending on whether you are using the remote or local MCP server.

About enterprise MCP server configuration

The {% data variables.product.github %} MCP server supports two enterprise deployment types:

{% data variables.enterprise.data_residency %}: Supports both remote and local MCP server configurations
{% data variables.product.prodname_ghe_server %}: Supports only local MCP server configuration

Important

{% data variables.product.prodname_ghe_server %} does not support remote MCP server hosting. If you are using {% data variables.product.prodname_ghe_server %}, you must use the local MCP server configuration described in Configuring the local MCP server for enterprise. Skip the remote MCP server configuration section below.

Prerequisites

A {% data variables.product.prodname_ghe_server %} instance or {% data variables.product.prodname_ghe_cloud %} account with {% data variables.enterprise.data_residency_short %}
The {% data variables.product.github %} MCP server configured in your editor. See AUTOTITLE.

Configuring the remote MCP server for {% data variables.enterprise.data_residency %}

Note

This section applies only to {% data variables.enterprise.data_residency %}. If you are using {% data variables.product.prodname_ghe_server %}, skip to Configuring the local MCP server for enterprise.

{% vscode %}

{% data variables.enterprise.data_residency %} can use the remote MCP server. To configure it, you need to update the MCP server URL to point to your {% data variables.product.prodname_ghe_cloud %} instance.

For example, if your {% data variables.product.prodname_ghe_cloud %} instance is https://octocorp.ghe.com, the MCP server URL would be https://copilot-api.octocorp.ghe.com/mcp.

In {% data variables.product.prodname_vscode %}, open the command palette by pressing Ctrl+Shift+P (Windows/Linux) / Command+Shift+P (Mac).
Type and select MCP: Open User Configuration.
In the settings file, locate the servers section. If you have already configured the {% data variables.product.github %} MCP server, you will see a github entry.

Update the url field to point to your {% data variables.product.prodname_ghe_cloud %} instance.

Option A: With PAT authentication

{
  "servers": {
    "github": {
      "type": "http",
      "url": "https://copilot-api.{% data variables.enterprise.data_residency_domain %}/mcp",
      "headers": {
        "Authorization": "Bearer ${input:github_mcp_pat}"
      }
    }
  },
  "inputs": [
    {
      "type": "promptString",
      "id": "github_mcp_pat",
      "description": "GitHub PAT",
      "password": true
    }
  ]
}

Option B: With OAuth authentication

{
  "servers": {
    "github": {
      "type": "http",
      "url": "https://copilot-api.{% data variables.enterprise.data_residency_domain %}/mcp"
    }
  }
}

Replace {% data variables.enterprise.data_residency_domain %} with your {% data variables.enterprise.data_residency_site %} subdomain.

Save the file.
When using OAuth with {% data variables.enterprise.data_residency %}, configure your {% data variables.product.prodname_vscode_shortname %} settings to point to your {% data variables.product.prodname_ghe_cloud %} instance. Add the following to your {% data variables.product.prodname_vscode_shortname %} user settings:
```
{
  "github-enterprise.uri": "https://copilot-api.{% data variables.enterprise.data_residency_domain %}/mcp"
}
```
Restart {% data variables.product.prodname_vscode %} or reload the window for the changes to take effect.

{% endvscode %}

{% visualstudio %}

{% data variables.product.prodname_ghe_cloud %} with data residency can use the remote MCP server. To configure it, you need to update the MCP server URL to point to your {% data variables.product.prodname_ghe_cloud %} instance.

For example, if your {% data variables.product.prodname_ghe_cloud %} instance is https://octocorp.ghe.com, the MCP server URL would be https://copilot-api.octocorp.ghe.com/mcp.

In the {% data variables.product.prodname_vs %} menu bar, click View, then click {% data variables.copilot.copilot_chat %}.
At the bottom of the chat panel, select Agent from the mode dropdown.
In the {% data variables.copilot.copilot_chat_short %} window, click the tools icon, then click the plus icon in the tool picker window.
In the "Configure MCP server" pop-up window, fill out the fields.
1. For "Server ID", type github.
2. For "Type", select "HTTP/SSE" from the dropdown.
3. For "URL", type https://copilot-api.YOURSUBDOMAIN.ghe.com/mcp, replacing YOURSUBDOMAIN with your {% data variables.product.prodname_ghe_cloud %} subdomain.
4. Add a new header under "Headers", called "Authorization" and set to the value Bearer YOUR_GITHUB_PAT, replacing "YOUR_GITHUB_PAT" with your {% data variables.product.pat_generic %}.
Click Save.

{% endvisualstudio %}

{% jetbrains %}

For example, if your {% data variables.product.prodname_ghe_cloud %} instance is https://octocorp.ghe.com, the MCP server URL would be https://copilot-api.octocorp.ghe.com/mcp.

{% data reusables.copilot.jetbrains-mcp-setup-steps %}

In the mcp.json file, add the following configuration, replacing YOURSUBDOMAIN with your {% data variables.product.prodname_ghe_cloud %} subdomain and YOUR_GITHUB_PAT with your {% data variables.product.pat_generic %}:

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

{% endjetbrains %}

{% xcode %}

For example, if your {% data variables.product.prodname_ghe_cloud %} instance is https://octocorp.ghe.com, the MCP server URL would be https://copilot-api.octocorp.ghe.com/mcp.

{% data reusables.copilot.xcode-mcp-setup-steps %}

Add the following configuration, replacing YOURSUBDOMAIN with your {% data variables.product.prodname_ghe_cloud %} subdomain and YOUR_GITHUB_PAT with your {% data variables.product.pat_generic %}:

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

{% endxcode %}

{% eclipse %}

For example, if your {% data variables.product.prodname_ghe_cloud %} instance is https://octocorp.ghe.com, the MCP server URL would be https://copilot-api.octocorp.ghe.com/mcp.

{% data reusables.copilot.eclipse-mcp-setup-steps %}

Add the following configuration under "Server Configurations", replacing YOURSUBDOMAIN with your {% data variables.product.prodname_ghe_cloud %} subdomain and YOUR_GITHUB_PAT with your {% data variables.product.pat_generic %}:

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

Click Apply.

{% endeclipse %}

Configuring the local MCP server for enterprise

Both {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} with data residency support the local MCP server. You can configure the local server using either the GITHUB_HOST environment variable or the --gh-host command-line flag.

Important considerations

For {% data variables.product.prodname_ghe_server %}: Prefix the hostname with the https:// URI scheme, as it otherwise defaults to http://, which {% data variables.product.prodname_ghe_server %} does not support.
For {% data variables.product.prodname_ghe_cloud %} with data residency: Use https://YOURSUBDOMAIN.ghe.com as the hostname.

Configuration with Docker

{% vscode %}

To configure the local MCP server with Docker in {% data variables.product.prodname_vscode %}:

In {% data variables.product.prodname_vscode %}, open the command palette by pressing Ctrl+Shift+P (Windows/Linux) / Command+Shift+P (Mac).
Type and select MCP: Open User Configuration.
In the settings file, locate the servers section or create it if it doesn't exist.

Add the following configuration:

For {% data variables.product.prodname_ghe_server %}:

{
  "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"
      }
    }
  }
}

Replace YOUR_GHES_HOSTNAME with your {% data variables.product.prodname_ghe_server %} hostname (for example, https://github.example.com).

For {% data variables.product.prodname_ghe_cloud %} with data residency:

{
  "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"
      }
    }
  }
}

Replace YOURSUBDOMAIN with your {% data variables.product.prodname_ghe_cloud %} subdomain.

Save the file.
Restart {% data variables.product.prodname_vscode %} or reload the window for the changes to take effect.

{% endvscode %}

{% visualstudio %}

To configure the local MCP server with Docker in {% data variables.product.prodname_vs %}, you need to manually edit the mcp.json file.

Open the mcp.json file in {% data variables.product.prodname_vs %}. The file is typically located in your user profile directory.

Add the following configuration:

For {% data variables.product.prodname_ghe_server %}:

{
  "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"
        }
      }
    }
  }
}

Replace YOUR_GHES_HOSTNAME with your {% data variables.product.prodname_ghe_server %} hostname (for example, https://github.example.com).

For {% data variables.product.prodname_ghe_cloud %} with data residency:

{
  "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"
        }
      }
    }
  }
}

Replace YOURSUBDOMAIN with your {% data variables.product.prodname_ghe_cloud %} subdomain.

Save the file.

{% endvisualstudio %}

{% jetbrains %}

To configure the local MCP server with Docker in JetBrains IDEs:

{% data reusables.copilot.jetbrains-mcp-setup-steps %}

Add the following configuration:

For {% data variables.product.prodname_ghe_server %}:

{
  "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"
      }
    }
  }
}

Replace YOUR_GHES_HOSTNAME with your {% data variables.product.prodname_ghe_server %} hostname (for example, https://github.example.com).

For {% data variables.product.prodname_ghe_cloud %} with data residency:

{
  "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"
      }
    }
  }
}

Replace YOURSUBDOMAIN with your {% data variables.product.prodname_ghe_cloud %} subdomain.

{% endjetbrains %}

{% xcode %}

To configure the local MCP server with Docker in Xcode:

{% data reusables.copilot.xcode-mcp-setup-steps %}

Add the following configuration:

For {% data variables.product.prodname_ghe_server %}:

{
  "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"
      }
    }
  }
}

Replace YOUR_GHES_HOSTNAME with your {% data variables.product.prodname_ghe_server %} hostname (for example, https://github.example.com).

For {% data variables.product.prodname_ghe_cloud %} with data residency:

{
  "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"
      }
    }
  }
}

Replace YOURSUBDOMAIN with your {% data variables.product.prodname_ghe_cloud %} subdomain.

{% endxcode %}

{% eclipse %}

To configure the local MCP server with Docker in Eclipse:

{% data reusables.copilot.eclipse-mcp-setup-steps %}

Add the following configuration under "Server Configurations":

For {% data variables.product.prodname_ghe_server %}:

{
  "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"
      }
    }
  }
}

Replace YOUR_GHES_HOSTNAME with your {% data variables.product.prodname_ghe_server %} hostname (for example, https://github.example.com).

For {% data variables.product.prodname_ghe_cloud %} with data residency:

{
  "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"
      }
    }
  }
}

Replace YOURSUBDOMAIN with your {% data variables.product.prodname_ghe_cloud %} subdomain.

Click Apply.

{% endeclipse %}

Configuration when building from source

If you are building the MCP server from source instead of using Docker, you can set the GITHUB_HOST environment variable or use the --gh-host command-line flag:

Using environment variable:

export GITHUB_HOST="https://YOUR_GHES_OR_GHEC_HOSTNAME"
./github-mcp-server stdio

Using command-line flag:

./github-mcp-server --gh-host \
  "https://YOUR_GHES_OR_GHEC_HOSTNAME" stdio

Replace YOUR_GHES_OR_GHEC_HOSTNAME with your {% data variables.product.prodname_ghe_server %} hostname (for example, https://github.example.com) or {% data variables.product.prodname_ghe_cloud %} hostname (for example, https://octocorp.ghe.com).

Next steps

To learn how to use the {% data variables.product.github %} MCP server, see AUTOTITLE.
To learn how to configure toolsets for the {% data variables.product.github %} MCP server, see AUTOTITLE.

21 KiB Raw Permalink Blame History

About enterprise MCP server configuration

Prerequisites

Configuring the remote MCP server for {% data variables.enterprise.data_residency %}

Configuring the local MCP server for enterprise

Important considerations

Configuration with Docker

Configuration when building from source

Next steps

21 KiB

Raw Permalink Blame History