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

moonbox3 · Copilot · web-flow · commit d5e240b37555 · 2026-03-09T09:57:51.000Z
* 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>
diff --git a/.github/actions/python-setup/action.yml b/.github/actions/python-setup/action.yml
@@ -8,6 +8,10 @@ inputs:
     os:
       description: The operating system to set up
       required: true
+    exclude-packages:
+      description: Space-separated list of packages to exclude from uv sync
+      required: false
+      default: ''
 
 runs:
     using: "composite"
@@ -19,6 +23,20 @@ runs:
             enable-cache: true
             cache-suffix: ${{ inputs.os }}-${{ inputs.python-version }}
             cache-dependency-glob: "**/uv.lock"
+      - name: Exclude incompatible workspace packages
+        if: ${{ inputs.exclude-packages != '' }}
+        shell: bash
+        run: |
+          for pkg in ${{ inputs.exclude-packages }}; do
+            for f in python/packages/*/pyproject.toml; do
+              if grep -q "name = \"$pkg\"" "$f"; then
+                pkg_dir=$(dirname "$f" | sed 's|python/||')
+                echo "Excluding workspace package: $pkg ($pkg_dir)"
+                sed -i.bak '/\[tool\.uv\.workspace\]/a\exclude = ["'"$pkg_dir"'"]' python/pyproject.toml
+                sed -i.bak '/'"$pkg"' = { workspace = true }/d' python/pyproject.toml
+              fi
+            done
+          done
       - name: Install the project
         shell: bash
         run: |
diff --git a/.github/workflows/python-code-quality.yml b/.github/workflows/python-code-quality.yml
@@ -18,7 +18,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.10"]
+        python-version: ["3.11"]
     runs-on: ubuntu-latest
     continue-on-error: true
     defaults:
@@ -55,7 +55,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.10"]
+        python-version: ["3.11"]
     runs-on: ubuntu-latest
     continue-on-error: true
     defaults:
@@ -84,7 +84,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.10"]
+        python-version: ["3.11"]
     runs-on: ubuntu-latest
     continue-on-error: true
     defaults:
@@ -117,7 +117,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.10"]
+        python-version: ["3.11"]
     runs-on: ubuntu-latest
     continue-on-error: true
     defaults:
diff --git a/.github/workflows/python-integration-tests.yml b/.github/workflows/python-integration-tests.yml
@@ -170,7 +170,7 @@ jobs:
     environment: integration
     timeout-minutes: 60
     env:
-      UV_PYTHON: "3.10"
+      UV_PYTHON: "3.11"
       OPENAI_CHAT_MODEL_ID: ${{ vars.OPENAI__CHATMODELID }}
       OPENAI_RESPONSES_MODEL_ID: ${{ vars.OPENAI__RESPONSESMODELID }}
       OPENAI_API_KEY: ${{ secrets.OPENAI__APIKEY }}
diff --git a/.github/workflows/python-lab-tests.yml b/.github/workflows/python-lab-tests.yml
@@ -67,6 +67,7 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
           os: ${{ runner.os }}
+          exclude-packages: ${{ matrix.python-version == '3.10' && 'agent-framework-github-copilot' || '' }}
         env:
           # Configure a constant location for the uv cache
           UV_CACHE_DIR: /tmp/.uv-cache
diff --git a/.github/workflows/python-merge-tests.yml b/.github/workflows/python-merge-tests.yml
@@ -288,7 +288,7 @@ jobs:
     runs-on: ubuntu-latest
     environment: integration
     env:
-      UV_PYTHON: "3.10"
+      UV_PYTHON: "3.11"
       OPENAI_CHAT_MODEL_ID: ${{ vars.OPENAI__CHATMODELID }}
       OPENAI_RESPONSES_MODEL_ID: ${{ vars.OPENAI__RESPONSESMODELID }}
       OPENAI_API_KEY: ${{ secrets.OPENAI__APIKEY }}
diff --git a/.github/workflows/python-test-coverage.yml b/.github/workflows/python-test-coverage.yml
@@ -20,7 +20,7 @@ jobs:
       run:
         working-directory: python
     env:
-      UV_PYTHON: "3.10"
+      UV_PYTHON: "3.11"
     steps:
       - uses: actions/checkout@v6
       # Save the PR number to a file since the workflow_run event
diff --git a/.github/workflows/python-tests.yml b/.github/workflows/python-tests.yml
@@ -34,12 +34,13 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
           os: ${{ runner.os }}
+          exclude-packages: ${{ matrix.python-version == '3.10' && 'agent-framework-github-copilot' || '' }}
         env:
           # Configure a constant location for the uv cache
           UV_CACHE_DIR: /tmp/.uv-cache
       # Unit tests
       - name: Run all tests
-        run: uv run poe all-tests
+        run: uv run poe all-tests ${{ matrix.python-version == '3.10' && '--ignore-glob=packages/github_copilot/**' || '' }}
         working-directory: ./python
 
       # Surface failing tests
diff --git a/python/packages/core/pyproject.toml b/python/packages/core/pyproject.toml
@@ -55,7 +55,7 @@ all = [
     "agent-framework-devui",
     "agent-framework-durabletask",
     "agent-framework-foundry-local",
-    "agent-framework-github-copilot",
+    "agent-framework-github-copilot; python_version >= '3.11'",
     "agent-framework-lab",
     "agent-framework-mem0",
     "agent-framework-ollama",
diff --git a/python/packages/github_copilot/agent_framework_github_copilot/_agent.py b/python/packages/github_copilot/agent_framework_github_copilot/_agent.py
@@ -26,12 +26,11 @@
 from agent_framework._types import AgentRunInputs, normalize_tools
 from agent_framework.exceptions import AgentException
 from copilot import CopilotClient, CopilotSession
-from copilot.generated.session_events import SessionEvent, SessionEventType
+from copilot.generated.session_events import PermissionRequest, SessionEvent, SessionEventType
 from copilot.types import (
     CopilotClientOptions,
     MCPServerConfig,
     MessageOptions,
-    PermissionRequest,
     PermissionRequestResult,
     ResumeSessionConfig,
     SessionConfig,
@@ -529,21 +528,21 @@ def _tool_to_copilot_tool(self, ai_func: FunctionTool) -> CopilotTool:
         """Convert an FunctionTool to a Copilot SDK tool."""
 
         async def handler(invocation: ToolInvocation) -> ToolResult:
-            args = invocation.get("arguments", {})
+            args: dict[str, Any] = invocation.arguments or {}
             try:
                 if ai_func.input_model:
                     args_instance = ai_func.input_model(**args)
                     result = await ai_func.invoke(arguments=args_instance)
                 else:
                     result = await ai_func.invoke(arguments=args)
                 return ToolResult(
-                    textResultForLlm=str(result),
-                    resultType="success",
+                    text_result_for_llm=str(result),
+                    result_type="success",
                 )
             except Exception as e:
                 return ToolResult(
-                    textResultForLlm=f"Error: {e}",
-                    resultType="failure",
+                    text_result_for_llm=f"Error: {e}",
+                    result_type="failure",
                     error=str(e),
                 )
 
diff --git a/python/packages/github_copilot/pyproject.toml b/python/packages/github_copilot/pyproject.toml
@@ -3,7 +3,7 @@ name = "agent-framework-github-copilot"
 description = "GitHub Copilot integration for Microsoft Agent Framework."
 authors = [{ name = "Microsoft", email = "af-support@microsoft.com"}]
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 version = "1.0.0b260304"
 license-files = ["LICENSE"]
 urls.homepage = "https://aka.ms/agent-framework"
@@ -15,7 +15,6 @@ classifiers = [
   "Development Status :: 4 - Beta",
   "Intended Audience :: Developers",
   "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
@@ -24,7 +23,7 @@ classifiers = [
 ]
 dependencies = [
     "agent-framework-core>=1.0.0rc3",
-    "github-copilot-sdk>=0.1.0",
+    "github-copilot-sdk>=0.1.32",
 ]
 
 [tool.uv]
@@ -66,7 +65,7 @@ include = ["agent_framework_github_copilot"]
 [tool.mypy]
 plugins = ['pydantic.mypy']
 strict = true
-python_version = "3.10"
+python_version = "3.11"
 ignore_missing_imports = true
 disallow_untyped_defs = true
 no_implicit_optional = true
diff --git a/python/packages/github_copilot/tests/test_github_copilot_agent.py b/python/packages/github_copilot/tests/test_github_copilot_agent.py
@@ -16,6 +16,7 @@
 )
 from agent_framework.exceptions import AgentException
 from copilot.generated.session_events import Data, SessionEvent, SessionEventType
+from copilot.types import ToolInvocation, ToolResult
 
 from agent_framework_github_copilot import GitHubCopilotAgent, GitHubCopilotOptions
 
@@ -745,10 +746,11 @@ def my_tool(arg: str) -> str:
         config = call_args[0][0]
         copilot_tool = config["tools"][0]
 
-        result = await copilot_tool.handler({"arguments": {"arg": "test"}})
+        result = await copilot_tool.handler(ToolInvocation(arguments={"arg": "test"}))
 
-        assert result["resultType"] == "success"
-        assert result["textResultForLlm"] == "Result: test"
+        assert isinstance(result, ToolResult)
+        assert result.result_type == "success"
+        assert result.text_result_for_llm == "Result: test"
 
     async def test_tool_handler_returns_failure_result_on_error(
         self,
@@ -770,11 +772,61 @@ def failing_tool(arg: str) -> str:
         config = call_args[0][0]
         copilot_tool = config["tools"][0]
 
-        result = await copilot_tool.handler({"arguments": {"arg": "test"}})
+        result = await copilot_tool.handler(ToolInvocation(arguments={"arg": "test"}))
 
-        assert result["resultType"] == "failure"
-        assert "Something went wrong" in result["textResultForLlm"]
-        assert "Something went wrong" in result["error"]
+        assert isinstance(result, ToolResult)
+        assert result.result_type == "failure"
+        assert "Something went wrong" in result.text_result_for_llm
+        assert "Something went wrong" in result.error
+
+    async def test_tool_handler_rejects_raw_dict_invocation(
+        self,
+        mock_client: MagicMock,
+        mock_session: MagicMock,
+    ) -> None:
+        """Test that tool handler raises TypeError when called with a raw dict instead of ToolInvocation."""
+
+        def my_tool(arg: str) -> str:
+            """A test tool."""
+            return f"Result: {arg}"
+
+        agent = GitHubCopilotAgent(client=mock_client, tools=[my_tool])
+        await agent.start()
+
+        await agent._get_or_create_session(AgentSession())  # type: ignore
+
+        call_args = mock_client.create_session.call_args
+        config = call_args[0][0]
+        copilot_tool = config["tools"][0]
+
+        with pytest.raises((TypeError, AttributeError)):
+            await copilot_tool.handler({"arguments": {"arg": "test"}})
+
+    async def test_tool_handler_with_empty_arguments(
+        self,
+        mock_client: MagicMock,
+        mock_session: MagicMock,
+    ) -> None:
+        """Test that tool handler handles ToolInvocation with empty arguments."""
+
+        def no_args_tool() -> str:
+            """A tool with no arguments."""
+            return "no args result"
+
+        agent = GitHubCopilotAgent(client=mock_client, tools=[no_args_tool])
+        await agent.start()
+
+        await agent._get_or_create_session(AgentSession())  # type: ignore
+
+        call_args = mock_client.create_session.call_args
+        config = call_args[0][0]
+        copilot_tool = config["tools"][0]
+
+        result = await copilot_tool.handler(ToolInvocation(arguments={}))
+
+        assert isinstance(result, ToolResult)
+        assert result.result_type == "success"
+        assert result.text_result_for_llm == "no args result"
 
     def test_copilot_tool_passthrough(
         self,
@@ -784,7 +836,7 @@ def test_copilot_tool_passthrough(
         from copilot.types import Tool as CopilotTool
 
         async def tool_handler(invocation: Any) -> Any:
-            return {"textResultForLlm": "result", "resultType": "success"}
+            return {"text_result_for_llm": "result", "result_type": "success"}
 
         copilot_tool = CopilotTool(
             name="direct_tool",
@@ -813,7 +865,7 @@ def my_function(arg: str) -> str:
             return arg
 
         async def tool_handler(invocation: Any) -> Any:
-            return {"textResultForLlm": "result", "resultType": "success"}
+            return {"text_result_for_llm": "result", "result_type": "success"}
 
         copilot_tool = CopilotTool(
             name="direct_tool",
diff --git a/python/samples/02-agents/providers/github_copilot/github_copilot_with_file_operations.py b/python/samples/02-agents/providers/github_copilot/github_copilot_with_file_operations.py
@@ -15,16 +15,18 @@
 import asyncio
 
 from agent_framework.github import GitHubCopilotAgent
-from copilot.types import PermissionRequest, PermissionRequestResult
+from copilot.generated.session_events import PermissionRequest
+from copilot.types import PermissionRequestResult
 
 
-def prompt_permission(request: PermissionRequest, context: dict[str, str]) -> PermissionRequestResult:
+def prompt_permission(
+    request: PermissionRequest, context: dict[str, str]
+) -> PermissionRequestResult:
     """Permission handler that prompts the user for approval."""
-    kind = request.get("kind", "unknown")
-    print(f"\n[Permission Request: {kind}]")
+    print(f"\n[Permission Request: {request.kind}]")
 
-    if "path" in request:
-        print(f"  Path: {request.get('path')}")
+    if request.path is not None:
+        print(f"  Path: {request.path}")
 
     response = input("Approve? (y/n): ").strip().lower()
     if response in ("y", "yes"):
diff --git a/python/samples/02-agents/providers/github_copilot/github_copilot_with_mcp.py b/python/samples/02-agents/providers/github_copilot/github_copilot_with_mcp.py
@@ -15,7 +15,8 @@
 import asyncio
 
 from agent_framework.github import GitHubCopilotAgent
-from copilot.types import MCPServerConfig, PermissionRequest, PermissionRequestResult
+from copilot.generated.session_events import PermissionRequest
+from copilot.types import MCPServerConfig, PermissionRequestResult
 from dotenv import load_dotenv
 
 # Load environment variables from .env file
@@ -24,8 +25,7 @@
 
 def prompt_permission(request: PermissionRequest, context: dict[str, str]) -> PermissionRequestResult:
     """Permission handler that prompts the user for approval."""
-    kind = request.get("kind", "unknown")
-    print(f"\n[Permission Request: {kind}]")
+    print(f"\n[Permission Request: {request.kind}]")
 
     response = input("Approve? (y/n): ").strip().lower()
     if response in ("y", "yes"):
diff --git a/python/samples/02-agents/providers/github_copilot/github_copilot_with_multiple_permissions.py b/python/samples/02-agents/providers/github_copilot/github_copilot_with_multiple_permissions.py
@@ -21,18 +21,18 @@
 import asyncio
 
 from agent_framework.github import GitHubCopilotAgent
-from copilot.types import PermissionRequest, PermissionRequestResult
+from copilot.generated.session_events import PermissionRequest
+from copilot.types import PermissionRequestResult
 
 
 def prompt_permission(request: PermissionRequest, context: dict[str, str]) -> PermissionRequestResult:
     """Permission handler that prompts the user for approval."""
-    kind = request.get("kind", "unknown")
-    print(f"\n[Permission Request: {kind}]")
+    print(f"\n[Permission Request: {request.kind}]")
 
-    if "command" in request:
-        print(f"  Command: {request.get('command')}")
-    if "path" in request:
-        print(f"  Path: {request.get('path')}")
+    if request.full_command_text is not None:
+        print(f"  Command: {request.full_command_text}")
+    if request.path is not None:
+        print(f"  Path: {request.path}")
 
     response = input("Approve? (y/n): ").strip().lower()
     if response in ("y", "yes"):
diff --git a/python/samples/02-agents/providers/github_copilot/github_copilot_with_shell.py b/python/samples/02-agents/providers/github_copilot/github_copilot_with_shell.py
diff --git a/python/samples/02-agents/providers/github_copilot/github_copilot_with_url.py b/python/samples/02-agents/providers/github_copilot/github_copilot_with_url.py
diff --git a/python/uv.lock b/python/uv.lock
