快速入门:将 Azure MCP 服务器与 GitHub Copilot SDK 集成

在本快速入门中,你将GitHub Copilot SDK 配置为使用Azure模型上下文协议(MCP)工具,以便应用程序可以通过自然语言与Azure资源进行交互。

Azure MCP 提供了允许 AI 助手直接与Azure资源交互的工具。 将这些工具与 Copilot SDK 集成后,可以生成使用自然语言管理Azure订阅、资源组、存储帐户等的应用程序。

先决条件

登录到 Azure MCP 服务器进行本地开发

Azure MCP 服务器使用适用于 .NET 的 Azure 标识库对 Microsoft Entra ID 进行身份验证。 服务器支持 两种身份验证模式:

  • 代理模式:使用操作系统的原生身份验证(如 Windows Web 帐户管理器)与 InteractiveBrowserCredential一起使用。
  • 凭据链模式:按顺序尝试多种身份验证方法:环境变量、Visual Studio Code、Visual Studio、Azure CLI、Azure PowerShell、Azure 开发人员 CLI 和交互式浏览器身份验证。

使用以下任一方法登录:

  1. 打开命令面板(Ctrl+Shift+P 或在 Mac 上使用 Cmd+Shift+P)。
  2. 运行 Azure:登录 并按照提示进行作。

登录后,Azure MCP 服务器可以根据权限对 Azure 服务进行身份验证和运行作。

Azure MCP 服务器配置示例

无论使用的编程 SDK 如何,都必须在应用上下文中配置 Azure MCP 服务器,以便其工具可用。 以下示例显示了最小配置:

{
  "mcp_servers": {
    "azure-mcp": {
      "type": "local",
      "command": "npx",
      "args": ["-y", "@azure/mcp@latest", "server", "start"],
      "tools": ["*"]
    }
  }
}

该 tools: ["*"] 参数为会话启用 MCP 服务器中的所有工具。 在许多情况下,你应该改为提供一份具体的工具名称列表,这样 Copilot 会话就只能调用你的应用所需的 Azure MCP工具。 以下示例把会话限制为少量工具:

{
  "mcp_servers": {
    "azure-mcp": {
      "type": "local",
      "command": "npx",
      "args": ["-y", "@azure/mcp@latest", "server", "start"],
      "tools": ["group_list", "storage_account_list", "subscription_list"]
    }
  }
}

有关可用工具名称的完整列表,请参阅Azure MCP 服务器工具。

集成示例

以下示例演示如何以不同语言集成 SDK。

注释

为了加快启动速度,可以使用全局 npm install -g @azure/mcp@latest安装 Azure MCP 服务器。

注释

以下示例使用 --allow-all-tools 并 --allow-all-paths 让示例保持简单。 对于每个应用,不需要或建议使用这些标志。 将 CLI 权限和 MCP tools 配置限定为应用实际需要的内容— 广泛的“允许所有”设置可以公开比Azure MCP 集成所需的更多工具和文件系统访问权限。

安装

使用 pip 安装 Python SDK 包。

pip install github-copilot-sdk

代码示例

以下代码演示了完整的流:

import asyncio
from copilot import CopilotClient
from copilot.generated.session_events import SessionEventType

async def main():
    # Initialize the Copilot client
    client = CopilotClient({
        "cli_args": [
            "--allow-all-tools",
            "--allow-all-paths",
        ]
    })

    await client.start()

    # Configure Azure MCP server in session config
    azure_mcp_config = {
        "azure-mcp": {
            "type": "local",
            "command": "npx",
            "args": ["-y", "@azure/mcp@latest", "server", "start"],
            "tools": ["*"],  # Enable all Azure MCP tools
        }
    }

    # Create session with MCP servers
    session = await client.create_session({
        "model": "gpt-4.1",  # Default model; BYOK can override
        "streaming": True,
        "mcp_servers": azure_mcp_config,
    })

    # Handle events
    def handle_event(event):
        if event.type == SessionEventType.ASSISTANT_MESSAGE_DELTA:
            if hasattr(event.data, 'delta_content') and event.data.delta_content:
                print(event.data.delta_content, end="", flush=True)
        elif event.type == SessionEventType.TOOL_EXECUTION_START:
            tool_name = getattr(event.data, 'tool_name', 'unknown')
            print(f"\n[TOOL: {tool_name}]")

    session.on(handle_event)

    # Send prompt
    await session.send_and_wait({
        "prompt": "List all resource groups in my Azure subscription"
    })

    await client.stop()

if __name__ == "__main__":
    asyncio.run(main())

前面的代码:

  • 初始化 Copilot 客户端。
  • 使用 npx.. 配置 Azure MCP 服务器。
  • 创建启用了 GPT-4.1 模型和流式传输的会话。
  • 处理事件以打印助理响应和工具执行日志。
  • 发送提示以列出 Azure 资源组。