# 为存储库配置 MCP 服务器
为你的存储库配置模型上下文协议 (MCP) 服务器，使 Copilot云代理 和 Copilot 代码评审 能够访问外部工具和数据源。
## 先决条件
在为存储库设置 MCP 服务器之前，请阅读 [关于模型上下文协议 (MCP)](/zh/copilot/concepts/context/mcp) 和 [模型上下文协议（MCP）和GitHub Copilot云代理](/zh/copilot/concepts/agents/cloud-agent/mcp-and-cloud-agent)。
## Introduction
作为存储库管理员，可以将 MCP 服务器配置为在存储库中使用。 使用 JSON 格式的配置完成此操作，该配置指定要使用的 MCP 服务器的详细信息。 直接在存储库 GitHub.com的设置中输入 JSON 配置。
此存储库级 MCP 配置由 Copilot云代理 和 Copilot 代码评审共享。 有关由Copilot 代码评审禁用使用 MCP 服务器的信息，请参阅[为Copilot 代码评审禁用 MCP 工具](#disabling-mcp-tools-for-code-review)。
> \[!NOTE]
>
> * 对代理技能和 MCP 服务器的 Copilot 代码评审 支持目前处于 公开预览 中，后续可能会有所变动。
> * 以前在设置下 Copilot云代理 管理的现有存储库 MCP 配置会自动移动到新的共享 MCP 设置页。 无需迁移操作。
GitHub MCP 服务器和 Playwright MCP 服务器默认处于启用状态。 你可以在这些默认服务器之外添加自己的 MCP 服务器。
组织和企业管理员还可以使用 YAML frontmatter，将 MCP 服务器配置为 自定义代理 的一部分。 有关详细信息，请参阅“[自定义代理配置](/zh/copilot/reference/custom-agents-configuration#mcp-server-configuration-details)”。
> \[!WARNING]
> 配置 MCP 服务器后， Copilot 将能够自主使用服务器提供的工具，并且在使用前不会请求批准。
为供 Copilot云代理 和 Copilot 代码评审 使用而配置 MCP 服务器时，请记住：
* Copilot云代理 和 Copilot 代码评审 仅支持 MCP 工具。 它们当前不支持 MCP 服务器提供的资源或提示。
* Copilot云代理 和 Copilot 代码评审 目前均不支持使用 OAuth 进行身份验证和授权的远程 MCP 服务器。
## 将 MCP 配置添加到存储库
存储库管理员可以按照以下步骤配置 MCP 服务器：
1. 在 GitHub 上，导航到存储库的主页面。
2. 在仓库名称下，单击 “Settings”\*\*\*\*。 如果看不到“设置”选项卡，请选择“”下拉菜单，然后单击“设置”。
3. 在边栏的“代码与自动化”部分，单击 **Copilot**，然后单击 **MCP 服务器**。
4. 在“模型上下文协议（MCP）”页上，在“MCP 配置”部分中添加配置。
本文中的以下各节解释如何编写需要在此处输入的 JSON 配置。
5. 单击“ **保存 MCP 配置**”。
系统将验证配置以确保其语法正确。
6. 如果 MCP 服务器需要变量、密钥或机密，请添加名称为 `COPILOT_MCP_`前缀的代理机密或变量。 只有带有前缀名称 `COPILOT_MCP_` 的代理机密和变量可用于 MCP 配置。 请参阅“[为 Copilot 云代理配置机密和变量](/zh/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/configure-secrets-and-variables)”。
## 编写 MCP 服务器的 JSON 配置
使用专用 JSON 格式配置 MCP 服务器。 JSON 必须包含一个 `mcpServers` 对象，其中键是 MCP 服务器的名称（例如 `sentry`），值是具有该 MCP 服务器的配置的对象。
```json copy
{
"mcpServers": {
"MCP SERVER 1": {
"command": "VALUE",
"args": [ VALUES ],
...
},
"MCP SERVER 2": {
"command": "VALUE",
"args": [ VALUES ],
...
},
...
}
}
```
配置对象可包含以下键：
本地和远程 MCP 服务器的必需密钥\*\*\*\*
* `tools` (`string[]`)：要启用的 MCP 服务器中的工具。 有可能在服务器的文档或代码中找到工具列表。 我们强烈建议你将特定的只读工具列入允许列表，因为代理将能够自主使用这些工具，且不会事先征求你的批准。 你还可通过在数组中包含 `*` 来启用所有工具。
* `type` （`string`）： Copilot云代理 接受 `"local"`、 `"stdio"`、 `"http"`或 `"sse"`。
本地 MCP 特定密钥\*\*\*\*
* `command` (`string`)：必需。 启动 MCP 服务器时要运行的命令。
* `args` (`string[]`)：必需。 要传递给 `command` 的参数。
* `env` (`object`)：可选。 需传递至服务器的环境变量。 此对象应将应公开给 MCP 服务器的环境变量的名称映射到以下其中一项：
* 对环境中的 Copilot 机密或变量的替换引用，例如 `$COPILOT_MCP_API_KEY` 或 `${COPILOT_MCP_API_KEY}`。 引用的名称必须以 . 开头 `COPILOT_MCP_`。
* 一个文本字符串值。
远程 MCP 特定密钥\*\*\*\*
* `url` (`string`)：必需。 MCP 服务器的 URL。
* `headers` (`object`)：可选。 要附加到对服务器的请求的标头。 此对象应将标头键的名称映射到以下项之一：
* 对环境中的 Copilot 机密或变量的替换引用，例如 `$COPILOT_MCP_API_KEY` 或 `${COPILOT_MCP_API_KEY}`。 引用的名称必须以 . 开头 `COPILOT_MCP_`。
* 一个文本字符串值。
请注意，所有`string`和`string[]`字段，都支持替换为您在`tools`环境中配置的变量或机密，`type`和Copilot除外。
### 变量替换
在环境中引用配置的 Copilot 环境变量时，支持以下语法模式：
| Syntax | 示例 |
| ----------------- | ---------------------------------------- |
| `$VAR` | `$COPILOT_MCP_API_KEY` |
| `${VAR}` | `${COPILOT_MCP_API_KEY}` |
| `${VAR:-default}` | `${COPILOT_MCP_API_KEY:-fallback_value}` |
## 示例配置
以下示例显示了不同提供程序的 MCP 服务器配置。
* [Sentry](#example-sentry)
* [Notion](#example-notion)
* [Azure](#example-azure)
* [Cloudflare](#example-cloudflare)
* [Azure DevOps](#example-azure-devops)
* [Atlassian](#example-atlassian)
### 示例：Sentry
[Sentry MCP 服务器](https://github.com/getsentry/sentry-mcp)提供Copilot对 [Sentry](https://sentry.io) 中记录的异常的经过身份验证的访问权限。
```javascript copy
// If you copy and paste this example, you will need to remove the comments prefixed with `//`, which are not valid JSON.
{
"mcpServers": {
"sentry": {
"type": "local",
"command": "npx",
// We can use the $SENTRY_HOST environment variable which is passed to
// the server because of the `env` value below.
"args": ["@sentry/mcp-server@latest", "--host=$SENTRY_HOST"],
"env": {
// We can specify an environment variable value as a string...
"SENTRY_HOST": "https://contoso.sentry.io",
// or refer to a variable or secret in your Copilot environment
// with a name starting with `COPILOT_MCP_`
"SENTRY_ACCESS_TOKEN": "$COPILOT_MCP_SENTRY_ACCESS_TOKEN"
}
}
}
}
```
### 示例：Notion
[Notion MCP 服务器](https://github.com/makenotion/notion-mcp-server)提供Copilot对[来自 Notion](https://notion.so) 的笔记和其他内容的经过身份验证的访问权限。
```javascript copy
// If you copy and paste this example, you will need to remove the comments prefixed with `//`, which are not valid JSON.
{
"mcpServers": {
"notionApi": {
"type": "local",
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"-e",
// We can use the $NOTION_API_KEY environment variable which is passed to
// the server because of the `env` value below.
"OPENAPI_MCP_HEADERS={\"Authorization\": \"Bearer $NOTION_API_KEY\", \"Notion-Version\": \"2022-06-28\"}",
"mcp/notion"
],
"env": {
// The value of the `COPILOT_MCP_NOTION_API_KEY` secret will be passed to the
// server command as an environment variable called `NOTION_API_KEY`
"NOTION_API_KEY": "$COPILOT_MCP_NOTION_API_KEY"
},
"tools": ["*"]
}
}
}
```
### 示例：Azure
[Microsoft MCP 存储库包括 Azure MCP](https://github.com/microsoft/mcp) 服务器，该服务器允许Copilot在更改代码时了解订阅中特定于 Azure 的文件和 Azure 资源。
若要使用 `copilot-setup-steps.yml` 文件自动配置存储库以使用Azure进行身份验证，以及用于身份验证的机密，请在本地克隆存储库，然后在存储库根目录中运行 [Azure Developer CLI](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/?ref_product=copilot\&ref_type=engagement\&ref_style=button)的 `azd cloud-agent config` 命令。
运行命令并合并创建的拉取请求后，即可将 MCP 配置添加到存储库。
```json copy
{
"mcpServers": {
"Azure": {
"type": "local",
"command": "npx",
"args": [
"-y",
"@azure/mcp@latest",
"server",
"start"
],
"tools": ["*"]
}
}
}
```
### 示例：Cloudflare
[Cloudflare MCP 服务器](https://github.com/cloudflare/mcp-server-cloudflare)在 Cloudflare 服务（包括处理文档和数据分析）之间创建连接。
```json copy
{
"mcpServers": {
"cloudflare": {
"type": "sse",
"url": "https://docs.mcp.cloudflare.com/sse",
"tools": ["*"]
}
}
}
```
### 示例：Azure DevOps
[Azure DevOps MCP 服务器](https://github.com/microsoft/azure-devops-mcp)在 Copilot 与Azure DevOps服务（包括工作项、管道或文档）之间创建无缝连接。
若要将 Azure DevOps MCP 服务器与 Copilot云代理 配合使用，必须更新存储库的copilot-setup-steps.yml文件，以包含 Azure 登录工作流步骤。
1. 在 Microsoft Entra 应用程序中配置 OIDC，并信任 GitHub。 请参阅 [使用 OpenID Connect 的 Azure 登录操作](https://learn.microsoft.com/en-us/azure/developer/github/connect-from-azure-openid-connect)。
2. 为应用程序标识设置对 Azure DevOps 组织和项目的访问权限。 请参阅[添加组织用户和管理访问权限](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/add-organization-users)。
3. 如果你还没有工作流文件，请在你的存储库中添加 `.github/workflows/copilot-setup-steps.yml` Actions 工作流文件。
4. 将 Azure 登录步骤添加到 `copilot-setup-steps` 工作流作业。
```yaml copy
# 此工作流使用未经 GitHub 认证的操作。
# 它们由第三方提供，并受
# 单独的服务条款、隐私政策和支持
# 文档。
on:
workflow_dispatch:
permissions:
id-token: write
contents: read
jobs:
copilot-setup-steps:
runs-on: ubuntu-latest
permissions:
id-token: write
contents: read
environment: copilot
steps:
- name: Azure login
uses: azure/login@a457da9ea143d694b1b9c7c869ebb04ebe844ef5
with:
client-id: ${{ secrets.AZURE_CLIENT_ID }}
tenant-id: ${{ secrets.AZURE_TENANT_ID }}
allow-no-subscriptions: true
```
此配置可确保 `azure/login` 在运行时执行 Copilot云代理 操作。
5. 为代理`AZURE_CLIENT_ID``AZURE_TENANT_ID`在组织或存储库级别配置机密。 有关详细信息，请参阅“[为 Copilot 云代理配置机密和变量](/zh/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/configure-secrets-and-variables)”。
6. 通过向 MCP 配置中添加一个 `ado` 对象，并加入您希望 Copilot 使用的工具，来配置 Azure DevOps MCP 服务器。
```json copy
{
"mcpServers": {
"ado": {
"type": "local",
"command": "npx",
"args": ["-y", "@azure-devops/mcp", "", "-a", "azcli"],
"tools": ["wit_get_work_item", "wit_get_work_items_batch_by_ids", ...]
}
}
}
```
### 示例：Atlassian
[Atlassian MCP 服务器](https://github.com/atlassian/atlassian-mcp-server)提供Copilot对 Atlassian 应用的身份验证访问权限，包括 Jira、Compass 和 Confluence。
有关使用 API 密钥向 Atlassian MCP 服务器进行身份验证的详细信息，请参阅 Atlassian 文档中 [的 API 令牌配置身份验证](https://support.atlassian.com/atlassian-rovo-mcp-server/docs/configuring-authentication-via-api-token/) 。
```javascript copy
// If you copy and paste this example, you will need to remove the comments prefixed with `//`, which are not valid JSON.
{
"mcpServers": {
"atlassian-rovo-mcp": {
"command": "npx",
"type": "local",
"tools": ["*"],
"args": [
"mcp-remote@latest",
"https://mcp.atlassian.com/v1/mcp",
// We can use the $ATLASSIAN_API_KEY environment variable which is passed
// to the server because of the `env` value below.
"--header",
"Authorization: Basic $ATLASSIAN_API_KEY"
],
"env": {
// The value of the `COPILOT_MCP_ATLASSIAN_API_KEY` secret will be passed
// to the server command as an environment variable
// called `ATLASSIAN_API_KEY`.
"ATLASSIAN_API_KEY": "$COPILOT_MCP_ATLASSIAN_API_KEY"
}
}
}
}
```
## 重用您在 Visual Studio Code 中的 MCP 配置
如果你已在 VS Code 中配置了 MCP 服务器，则可以在 GitHub 上为你的仓库 MCP 设置沿用类似的配置。
根据 VS Code 的配置方式，您可能可以在存储库的 `.vscode/mcp.json` 文件或机器的专用 `settings.json` 文件中找到 MCP 设置。
若要在 GitHub 上调整存储库 MCP 设置的配置，您需要：
1. 为每个 MCP 服务器添加一个 `tools` 密钥，指定哪些工具可供使用 Copilot。
2. 如果配置了 `inputs`，直接切换为使用 `env`。
3. 如果配置了 `envFile`，直接切换为使用 `env`。
4. 将 `inputs` 配置中对 `args` 的任何引用更新为引用 `env` 中的环境变量。
有关 MCP 的详细信息 VS Code，请参阅 [VS Code 文档](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)。
## 验证 MCP 配置
设置 MCP 配置后，应对其进行测试以确保设置正确。
### 使用 Copilot云代理 进行验证
1. 在存储库中创建问题，然后将其分配给 Copilot。
2. 等待几秒钟，然后Copilot将在问题上留下👀反应。
3. 再等待几秒钟，Copilot 将会创建一个拉取请求，该请求将显示在问题的时间轴中。
4. 单击时间线中创建的拉取请求，然后等待“Copilot 开始工作”时间线事件的出现。
5. 单击“ **查看会话** ”打开 Copilot云代理 日志。
6. 单击日志查看器右上角的省略号按钮（**...**），然后单击 **Copilot** 边栏。
7. 单击**Start MCP Servers**步骤以展开日志。
8. 如果 MCP 服务器成功启动，日志底部会列出其工具。
如果 MCP 服务器需要默认情况下未安装在运行程序上GitHub Actions的任何依赖项，例如`uv``pipx`，或者需要特殊设置步骤，则可能需要创建 `copilot-setup-steps.yml` Actions 工作流文件来安装它们。 有关详细信息，请参阅“[配置开发环境](/zh/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment)”。
### 使用 Copilot 代码评审 进行验证
1. 在存储库中打开拉取请求。
2. 向 Copilot请求评审。
3. 在拉取请求时间线中，点击**查看会话**打开关联的评审会话。 在会话日志中，查看“设置环境”部分，查看启动和调用了哪些 MCP 服务器和工具。
## 自定义内置 GitHub MCP 服务器
GitHub MCP 服务器默认处于启用状态，并通过使用仅对当前存储库具有只读访问权限的特殊作用域令牌连接到GitHub。
如果想要允许 Copilot 访问当前存储库外部的数据，则可以将其授予 personal access token 更广泛的访问权限。
1. 使用适当的权限创建一个 personal access token 。 我们建议使用一个 fine-grained personal access token，你可以在其中将令牌对特定存储库的访问限制为只读权限。 如需了解有关 personal access tokens 的更多信息，请参阅 [管理个人访问令牌](/zh/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)。
2. 在 GitHub 上，导航到存储库的主页面。
3. 在仓库名称下，单击 “Settings”\*\*\*\*。 如果看不到“设置”选项卡，请选择“”下拉菜单，然后单击“设置”。
4. 在侧边栏的“代码和自动化”部分中，点击 **Copilot**，然后点击 **MCP 服务器**。
5. 在“MCP 配置”部分中添加配置。 例如，可以添加以下内容：
```javascript copy
// If you copy and paste this example, you will need to remove the comments prefixed with `//`, which are not valid JSON.
{
"mcpServers": {
"github-mcp-server": {
"type": "http",
// Remove "/readonly" to enable wider access to all tools.
// Then, use the "X-MCP-Toolsets" header to specify which toolsets you'd like to include.
// Use the "tools" field to select individual tools from the toolsets.
"url": "https://api.githubcopilot.com/mcp/readonly",
"tools": ["*"],
"headers": {
"X-MCP-Toolsets": "repos,issues,users,pull_requests,code_security,secret_protection,actions,web_search"
}
}
}
}
```
有关工具集的详细信息，请参阅远程 MCP 服务器文档中的[](https://github.com/github/github-mcp-server?tab=readme-ov-file#available-toolsets)GitHub。
6. 单击“ **保存 MCP 配置**”。
7. 添加一个名为`COPILOT_MCP_GITHUB_PERSONAL_ACCESS_TOKEN`的代理机密，并将personal access token作为值。 可以在组织或存储库级别配置此配置。 有关详细信息，请参阅“[为 Copilot 云代理配置机密和变量](/zh/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/configure-secrets-and-variables)”。
有关在其他环境中使用 GitHub MCP 服务器的信息，请参阅 [在 IDE 中使用 GitHub MCP 服务器](/zh/copilot/customizing-copilot/using-model-context-protocol/using-the-github-mcp-server)。
## 禁用 MCP 工具进行代码评审
> \[!NOTE]
> 对使用 Copilot 代码评审 的代理技能和 MCP 服务器的支持处于 公开预览 阶段，且可能会有所变动。
在存储库设置中，默认启用 Copilot 代码评审 对 MCP 工具的使用。
如果您希望已配置的 MCP 服务器仅对 Copilot云代理 可用，而不对 Copilot 代码评审 可用，请禁用此设置。
如果禁用此设置， Copilot 代码评审 则不会在该存储库中调用 MCP 工具进行拉取请求评审，包括来自默认 GitHub 服务器和 Playwright MCP 服务器的工具。
1. 在 GitHub 上，导航到存储库的主页面。
2. 在仓库名称下，单击 “Settings”\*\*\*\*。 如果看不到“设置”选项卡，请选择“”下拉菜单，然后单击“设置”。
3. 在边栏的“代码和自动化”部分中，单击“**Copilot\*\*\*\*代码评审**”。
4. 单击**允许 Copilot 在审查拉取请求时使用 MCP 工具**开关，以禁用该设置。
## 后续步骤
* [为 GitHub Copilot 命令行界面 (CLI) 添加 MCP 服务器](/zh/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers)
* [使用 GitHub Copilot 代码审查](/zh/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review)
* [为Copilot云代理创建自定义代理](/zh/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents)
* [配置开发环境](/zh/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment)
* [使用 MCP（模型上下文协议）服务器扩展 GitHub Copilot 对话助手](/zh/copilot/customizing-copilot/extending-copilot-chat-with-mcp)