Add MCP sample

2026-06-16 21:04:09 +08:00 · 2026-03-16 13:35:59 -07:00
parent 3afedd1a32
commit 25e34a0b53
3 changed files with 101 additions and 2 deletions
@@ -12,12 +12,21 @@ The Model Context Protocol (MCP) is an open standard for connecting AI agents to
 |--------|------|-------------|
 | **Agent as MCP Server** | [`agent_as_mcp_server.py`](agent_as_mcp_server.py) | Shows how to expose an Agent Framework agent as an MCP server that other AI applications can connect to |
 | **API Key Authentication** | [`mcp_api_key_auth.py`](mcp_api_key_auth.py) | Demonstrates API key authentication with MCP servers |
-| **GitHub Integration with PAT** | [`mcp_github_pat.py`](mcp_github_pat.py) | Demonstrates connecting to GitHub's MCP server using Personal Access Token (PAT) authentication |
+| **GitHub Integration with PAT (OpenAI Responses)** | [`mcp_github_pat_openai_responses.py`](mcp_github_pat_openai_responses.py) | Demonstrates connecting to GitHub's MCP server using PAT with OpenAI Responses Client |
+| **GitHub Integration with PAT (Azure OpenAI)** | [`mcp_github_pat_azure_chat.py`](mcp_github_pat_azure_chat.py) | Demonstrates connecting to GitHub's MCP server using PAT with Azure OpenAI Chat Client |

 ## Prerequisites

 - `OPENAI_API_KEY` environment variable
 - `OPENAI_RESPONSES_MODEL_ID` environment variable

-For `mcp_github_pat.py`:
+For `mcp_github_pat_openai_responses.py`:
 - `GITHUB_PAT` - Your GitHub Personal Access Token (create at https://github.com/settings/tokens)
+- `OPENAI_API_KEY` - Your OpenAI API key
+- `OPENAI_RESPONSES_MODEL_ID` - Your OpenAI model ID
+
+For `mcp_github_pat_azure_chat.py`:
+- `GITHUB_PAT` - Your GitHub Personal Access Token (create at https://github.com/settings/tokens)
+- `AZURE_OPENAI_ENDPOINT` - Your Azure OpenAI endpoint
+- `AZURE_OPENAI_CHAT_DEPLOYMENT_NAME` - Your Azure OpenAI chat deployment name
+- Or use Azure CLI credential for authentication (run `az login`)
@@ -0,0 +1,90 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+import asyncio
+import os
+
+from agent_framework import MCPStreamableHTTPTool
+from agent_framework.azure import AzureOpenAIChatClient
+from azure.identity import AzureCliCredential
+from dotenv import load_dotenv
+from httpx import AsyncClient
+
+"""
+MCP GitHub Integration with Personal Access Token (PAT) using Azure OpenAI Chat Client
+
+This example demonstrates how to connect to GitHub's remote MCP server using a Personal Access
+Token (PAT) for authentication with Azure OpenAI Chat Client. The agent can use GitHub operations
+like searching repositories, reading files, creating issues, and more depending on how you scope
+your token.
+
+Prerequisites:
+1. A GitHub Personal Access Token with appropriate scopes
+   - Create one at: https://github.com/settings/tokens
+   - For read-only operations, you can use more restrictive scopes
+2. Environment variables:
+   - GITHUB_PAT: Your GitHub Personal Access Token (required)
+   - AZURE_OPENAI_ENDPOINT: Your Azure OpenAI endpoint (required)
+   - AZURE_OPENAI_CHAT_DEPLOYMENT_NAME: Your Azure OpenAI chat deployment name (required)
+   - Or use Azure CLI credential for authentication (run `az login`)
+"""
+
+
+async def github_mcp_example() -> None:
+    """Example of using GitHub MCP server with PAT authentication and Azure OpenAI Chat Client."""
+    # 1. Load environment variables from .env file if present
+    load_dotenv()
+
+    # 2. Get configuration from environment
+    github_pat = os.getenv("GITHUB_PAT")
+    if not github_pat:
+        raise ValueError(
+            "GITHUB_PAT environment variable must be set. Create a token at https://github.com/settings/tokens"
+        )
+
+    # 3. Create authentication headers with GitHub PAT
+    auth_headers = {
+        "Authorization": f"Bearer {github_pat}",
+    }
+
+    # 4. Create HTTP client with authentication headers
+    http_client = AsyncClient(headers=auth_headers)
+
+    # 5. Create Azure OpenAI Chat Client
+    # For authentication, run `az login` command in terminal or replace AzureCliCredential
+    # with your preferred authentication option (e.g., api_key parameter)
+    client = AzureOpenAIChatClient(credential=AzureCliCredential())
+
+    # 6. Create MCP tool for GitHub with PAT authentication
+    # The MCPStreamableHTTPTool manages the connection to the MCP server and makes its tools available
+    async with MCPStreamableHTTPTool(
+        name="GitHub",
+        description="GitHub MCP server for interacting with GitHub repositories, issues, and more",
+        url="https://api.githubcopilot.com/mcp/",
+        http_client=http_client,  # Pass HTTP client with authentication headers
+        approval_mode="never_require",  # For sample brevity; use "always_require" in production
+    ) as github_mcp_tool:
+        # 7. Create agent with the GitHub MCP tool
+        agent = client.as_agent(
+            instructions=(
+                "You are a helpful assistant that can help users interact with GitHub. "
+                "You can search for repositories, read file contents, check issues, and more. "
+                "Always be clear about what operations you're performing."
+            ),
+            tools=github_mcp_tool,
+        )
+
+        # Example 1: Get authenticated user information
+        query1 = "What is my GitHub username and tell me about my account?"
+        print(f"\nUser: {query1}")
+        result1 = await agent.run(query1)
+        print(f"Agent: {result1.text}")
+
+        # Example 2: List my repositories
+        query2 = "List all the repositories I own on GitHub"
+        print(f"\nUser: {query2}")
+        result2 = await agent.run(query2)
+        print(f"Agent: {result2.text}")
+
+
+if __name__ == "__main__":
+    asyncio.run(github_mcp_example())