Skip to content

AGENTS.md

Latest commit

 

History

History
47 lines (34 loc) · 1.71 KB

AGENTS.md

File metadata and controls

47 lines (34 loc) · 1.71 KB
Raw

GitHub Copilot Package (agent-framework-github-copilot)

Integration with GitHub Copilot extensions.

Main Classes

  • GitHubCopilotAgent - Agent for GitHub Copilot extensions
  • GitHubCopilotOptions - Options for Copilot agent configuration
  • GitHubCopilotSettings - Pydantic settings for configuration

Usage

from agent_framework.github import GitHubCopilotAgent

agent = GitHubCopilotAgent(...)
response = await agent.run("Hello")

Import Path

from agent_framework.github import GitHubCopilotAgent
# or directly:
from agent_framework_github_copilot import GitHubCopilotAgent

Session Option Defaults

_build_session_kwargs forwards options to the SDK verbatim except for a few keys that get an explicit default: on_permission_request (deny-all) and enable_file_hooks (False, so a session behaves the same way in every working directory). Callers opt in through default_options or per-run options. Keep such defaults to options the working directory controls: options that only shape prompt context (for example enable_host_git_operations) are deliberately left alone.

When the agent applies the enable_file_hooks default and the working directory actually defines hooks, _warn_once_about_unloaded_file_hooks logs a warning so the change in behavior is visible. It fires at most once per agent, and never when the caller set the option explicitly either way.

Delegated Agent Tools

The Copilot SDK tool adapter passes the parent agent and client service_session_state_keys declarations through FunctionInvocationContext. This lets nested as_tool(propagate_session=True) calls share application state without inheriting or replacing provider-owned continuation state.