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