github_copilot_basic.py

# Copyright (c) Microsoft. All rights reserved.

"""
GitHub Copilot Agent Basic Example

This sample demonstrates basic usage of GitHubCopilotAgent.
Shows both streaming and non-streaming responses with function tools.

Environment variables (optional):
- GITHUB_COPILOT_CLI_PATH - Path to the Copilot CLI executable
- GITHUB_COPILOT_MODEL - Model to use (e.g., "gpt-5", "claude-sonnet-4")
- GITHUB_COPILOT_TIMEOUT - Request timeout in seconds
- GITHUB_COPILOT_LOG_LEVEL - CLI log level
"""

import asyncio
from random import randint
from typing import Annotated

from agent_framework import tool
from agent_framework.github import GitHubCopilotAgent
from copilot.generated.session_events import PermissionRequest
from copilot.types import PermissionRequestResult
from dotenv import load_dotenv
from pydantic import Field

# Load environment variables from .env file
load_dotenv()


def prompt_permission(request: PermissionRequest, context: dict[str, str]) -> PermissionRequestResult:
    """Permission handler that prompts the user for approval."""
    print(f"\n[Permission Request: {request.kind}]")

    if request.full_command_text is not None:
        print(f"  Command: {request.full_command_text}")

    response = input("Approve? (y/n): ").strip().lower()
    if response in ("y", "yes"):
        return PermissionRequestResult(kind="approved")
    return PermissionRequestResult(kind="denied-interactively-by-user")


# NOTE: approval_mode="never_require" is for sample brevity. Use "always_require" in production;
# see samples/02-agents/tools/function_tool_with_approval.py
# and samples/02-agents/tools/function_tool_with_approval_and_sessions.py.
@tool(approval_mode="never_require")
def get_weather(
    location: Annotated[str, Field(description="The location to get the weather for.")],
) -> str:
    """Get the weather for a given location."""
    conditions = ["sunny", "cloudy", "rainy", "stormy"]
    return f"The weather in {location} is {conditions[randint(0, 3)]} with a high of {randint(10, 30)}C."


async def non_streaming_example() -> None:
    """Example of non-streaming response (get the complete result at once)."""
    print("=== Non-streaming Response Example ===")

    agent = GitHubCopilotAgent(
        instructions="You are a helpful weather agent.",
        tools=[get_weather],
        default_options={"on_permission_request": prompt_permission},
    )

    async with agent:
        query = "What's the weather like in Seattle?"
        print(f"User: {query}")
        result = await agent.run(query)
        print(f"Agent: {result}\n")


async def streaming_example() -> None:
    """Example of streaming response (get results as they are generated)."""
    print("=== Streaming Response Example ===")

    agent = GitHubCopilotAgent(
        instructions="You are a helpful weather agent.",
        tools=[get_weather],
        default_options={"on_permission_request": prompt_permission},
    )

    async with agent:
        query = "What's the weather like in Tokyo?"
        print(f"User: {query}")
        print("Agent: ", end="", flush=True)
        async for chunk in agent.run(query, stream=True):
            if chunk.text:
                print(chunk.text, end="", flush=True)
        print("\n")


async def runtime_options_example() -> None:
    """Example of overriding system message at runtime."""
    print("=== Runtime Options Example ===")

    agent = GitHubCopilotAgent(
        instructions="Always respond in exactly 3 words.",
        tools=[get_weather],
        default_options={"on_permission_request": prompt_permission},
    )

    async with agent:
        query = "What's the weather like in Paris?"

        # First call uses default instructions (3 words response)
        print("Using default instructions (3 words):")
        print(f"User: {query}")
        result1 = await agent.run(query)
        print(f"Agent: {result1}\n")

        # Second call overrides with runtime system_message in replace mode
        print("Using runtime system_message with replace mode (detailed response):")
        print(f"User: {query}")
        result2 = await agent.run(
            query,
            options={
                "system_message": {
                    "mode": "replace",
                    "content": "You are a weather expert. Provide detailed weather information "
                    "with temperature, and recommendations.",
                }
            },
        )
        print(f"Agent: {result2}\n")


async def main() -> None:
    print("=== Basic GitHub Copilot Agent Example ===")

    await non_streaming_example()
    await streaming_example()
    await runtime_options_example()


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