mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Eduard van Valkenburg
0521f5bed8
* [BREAKING] Rename ChatAgent -> Agent, ChatMessage -> Message, ChatClientProtocol -> SupportsChatGetResponse Simplify the public API by removing redundant 'Chat' prefix from core types: - ChatAgent -> Agent - RawChatAgent -> RawAgent - ChatMessage -> Message - ChatClientProtocol -> SupportsChatGetResponse Also renamed internal WorkflowMessage (was Message in _runner_context) to avoid collision. No backward compatibility aliases - this is a clean breaking change. * [BREAKING] Rename Agent chat_client parameter to client * Fix rebase issues: WorkflowMessage references and broken markdown links * Fix formatting and lint issues from code quality checks * Fix import ordering in workflow sample files * fixed rebase * Fix test failures: use WorkflowMessage and A2AMessage after ChatMessage→Message rename - Replace Message(data=..., source_id=...) with WorkflowMessage(...) in workflow tests - Fix isinstance check in A2A agent to use A2AMessage instead of Message - Fix import in test_workflow_observability.py (Message→WorkflowMessage) * Fix lint, fmt, and sample errors after ChatMessage→Message rename - Auto-fix 70+ ruff lint issues across samples (ChatMessage→Message refs) - Fix HostedVectorStoreContent→Content.from_hosted_vector_store in file search sample - Fix _normalize_messages→normalize_messages in custom agent sample - Fix context.terminate→raise MiddlewareTermination in middleware samples - Fix with_update_hook→with_transform_hook in override middleware sample - Add TOptions_co import back to custom_chat_client sample - Add noqa for FastAPI File() default in chatkit sample - Fix B023 loop variable capture in weather agent sample * fix: update Agent constructor calls from chat_client to client in declaration-only tool tests * fix: add register_cleanup to devui lazy-loading proxy and type stub * fixed tests and updated new pieces * fix agui typevar * fix merge errors * fix merge conflicts * fiux merge * Remove unused links --------- Co-authored-by: Evan Mattson <evan.mattson@microsoft.com>
82 lines
2.9 KiB
Python
82 lines
2.9 KiB
Python
# Copyright (c) Microsoft. All rights reserved.
|
|
|
|
import asyncio
|
|
import os
|
|
|
|
from agent_framework import Agent, HostedMCPTool
|
|
from agent_framework.openai import OpenAIResponsesClient
|
|
from dotenv import load_dotenv
|
|
|
|
"""
|
|
MCP GitHub Integration with Personal Access Token (PAT)
|
|
|
|
This example demonstrates how to connect to GitHub's remote MCP server using a Personal Access
|
|
Token (PAT) for authentication. 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)
|
|
- OPENAI_API_KEY: Your OpenAI API key (required)
|
|
- OPENAI_RESPONSES_MODEL_ID: Your OpenAI model ID (required)
|
|
"""
|
|
|
|
|
|
async def github_mcp_example() -> None:
|
|
"""Example of using GitHub MCP server with PAT authentication."""
|
|
# 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 MCP tool with authentication
|
|
# HostedMCPTool manages the connection to the MCP server and makes its tools available
|
|
# Set approval_mode="never_require" to allow the MCP tool to execute without approval
|
|
github_mcp_tool = HostedMCPTool(
|
|
name="GitHub",
|
|
description="Tool for interacting with GitHub.",
|
|
url="https://api.githubcopilot.com/mcp/",
|
|
headers=auth_headers,
|
|
approval_mode="never_require",
|
|
)
|
|
|
|
# 5. Create agent with the GitHub MCP tool
|
|
async with Agent(
|
|
client=OpenAIResponsesClient(),
|
|
name="GitHubAgent",
|
|
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,
|
|
) as agent:
|
|
# 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())
|