mirror of https://github.com/microsoft/agent-framework.git synced 2026-06-16 21:04:09 +08:00

Files

T

Evan Mattson d5e240b375 [BREAKING] Python: Update github-copilot-sdk integration to use ToolInvocation/ToolResult types (#4551 )

* Update github_copilot package for github-copilot-sdk>=0.1.32 (#4549)

- Update requires-python from >=3.10 to >=3.11
- Remove Python 3.10 classifier
- Update mypy python_version to 3.11
- Update dependency to github-copilot-sdk>=0.1.32
- Fix ToolResult API: use snake_case kwargs (text_result_for_llm,
  result_type) instead of camelCase (textResultForLlm, resultType)
- Update test assertions to use attribute access on ToolResult
- Add ToolResult type assertions to tool handler tests

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fix tests to use ToolInvocation dataclass instead of plain dict (#4549)

Update test_github_copilot_agent.py to pass ToolInvocation objects to tool
handlers instead of plain dicts, matching the github-copilot-sdk>=0.1.32 API
where ToolInvocation is a dataclass with an .arguments attribute.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Add regression tests for ToolInvocation contract (#4549)

Add tests to lock in the new ToolInvocation-based calling convention:
- test_tool_handler_rejects_raw_dict_invocation: verifies passing a raw
  dict (old calling convention) raises TypeError/AttributeError
- test_tool_handler_with_empty_arguments: verifies ToolInvocation with
  empty arguments works correctly for no-arg tools

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Revert requires-python to >=3.10 to avoid breaking CI (#4549)

The repo CI runs with Python 3.10 (uv sync --all-packages) and all other
packages require >=3.10. Raising this package to >=3.11 would break the
shared install flow. The SDK dependency version constraint (>=0.1.32) will
enforce any Python version requirement from the SDK itself.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fix min Python version for github_copilot package to >=3.11

github-copilot-sdk>=0.1.32 requires Python>=3.11, which conflicts
with the package's declared >=3.10 minimum, breaking uv sync.

* Bump py version for GH workflows to 3.11, exclude GHCP sdk from 3.10 items

* Fix uv command

* Fixes

* Update samples

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

d5e240b375 · 2026-03-09 09:57:51 +00:00

History

github_copilot_basic.py

Python: Add load_dotenv() to samples for .env file support (#4043 )

2026-02-19 10:55:13 +00:00

github_copilot_with_file_operations.py

[BREAKING] Python: Update github-copilot-sdk integration to use ToolInvocation/ToolResult types (#4551 )

2026-03-09 09:57:51 +00:00

github_copilot_with_mcp.py

[BREAKING] Python: Update github-copilot-sdk integration to use ToolInvocation/ToolResult types (#4551 )

2026-03-09 09:57:51 +00:00

github_copilot_with_multiple_permissions.py

[BREAKING] Python: Update github-copilot-sdk integration to use ToolInvocation/ToolResult types (#4551 )

2026-03-09 09:57:51 +00:00

github_copilot_with_session.py

Python: Add load_dotenv() to samples for .env file support (#4043 )

2026-02-19 10:55:13 +00:00

github_copilot_with_shell.py

[BREAKING] Python: Update github-copilot-sdk integration to use ToolInvocation/ToolResult types (#4551 )

2026-03-09 09:57:51 +00:00

github_copilot_with_url.py

[BREAKING] Python: Update github-copilot-sdk integration to use ToolInvocation/ToolResult types (#4551 )

2026-03-09 09:57:51 +00:00

README.md

Python: [BREAKING] PR2 — Wire context provider pipeline, remove old types, update all consumers (#3850 )

2026-02-12 21:00:32 +00:00

README.md

GitHub Copilot Agent Examples

This directory contains examples demonstrating how to use the GitHubCopilotAgent from the Microsoft Agent Framework.

Security Note: These examples demonstrate various permission types (shell, read, write, url). Only enable permissions that are necessary for your use case. Each permission grants the agent additional capabilities that could affect your system.

Prerequisites

GitHub Copilot CLI: Install and authenticate the Copilot CLI
GitHub Copilot Subscription: An active GitHub Copilot subscription

Install the package:

pip install agent-framework-github-copilot --pre

Environment Variables

The following environment variables can be configured:

Variable	Description	Default
`GITHUB_COPILOT_CLI_PATH`	Path to the Copilot CLI executable	`copilot`
`GITHUB_COPILOT_MODEL`	Model to use (e.g., "gpt-5", "claude-sonnet-4")	Server default
`GITHUB_COPILOT_TIMEOUT`	Request timeout in seconds	`60`
`GITHUB_COPILOT_LOG_LEVEL`	CLI log level	`info`

Examples

File	Description
`github_copilot_basic.py`	The simplest way to create an agent using `GitHubCopilotAgent`. Demonstrates both streaming and non-streaming responses with function tools.
`github_copilot_with_session.py`	Shows session management with automatic creation, persistence via session objects, and resuming sessions by ID.
`github_copilot_with_shell.py`	Shows how to enable shell command execution permissions. Demonstrates running system commands like listing files and getting system information.
`github_copilot_with_file_operations.py`	Shows how to enable file read and write permissions. Demonstrates reading file contents and creating new files.
`github_copilot_with_url.py`	Shows how to enable URL fetching permissions. Demonstrates fetching and processing web content.
`github_copilot_with_mcp.py`	Shows how to configure MCP (Model Context Protocol) servers, including local (stdio) and remote (HTTP) servers.
`github_copilot_with_multiple_permissions.py`	Shows how to combine multiple permission types for complex tasks that require shell, read, and write access.